Google Cloud Service Management V1 Client - Class Rollout (1.2.2)

Reference documentation and code samples for the Google Cloud Service Management V1 Client class Rollout.

A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.

Generated from protobuf message google.api.servicemanagement.v1.Rollout

Namespace

Google \ Cloud \ ServiceManagement \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ rollout_id`	`string` Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of
`↳ create_time`	`Google\Protobuf\Timestamp` Creation time of the rollout. Readonly.
`↳ created_by`	`string` The user who created the Rollout. Readonly.
`↳ status`	`int` The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
`↳ traffic_percent_strategy`	`Google\Cloud\ServiceManagement\V1\Rollout\TrafficPercentStrategy` Google Service Control selects service configurations based on traffic percentage.
`↳ delete_service_strategy`	`Google\Cloud\ServiceManagement\V1\Rollout\DeleteServiceStrategy` The strategy associated with a rollout to delete a `ManagedService`. Readonly.
`↳ service_name`	`string` The name of the service associated with this Rollout.

getRolloutId

Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed.

If not specified by client, the server will generate one. The generated id will have the form of

Returns
Type	Description
`string`

setRolloutId

Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed.

If not specified by client, the server will generate one. The generated id will have the form of

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Creation time of the rollout. Readonly.

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

hasCreateTime

clearCreateTime

setCreateTime

Creation time of the rollout. Readonly.

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

Returns
Type	Description
`$this`

getCreatedBy

The user who created the Rollout. Readonly.

Returns
Type	Description
`string`

setCreatedBy

The user who created the Rollout. Readonly.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

Returns
Type	Description
`int`

setStatus

The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getTrafficPercentStrategy

Google Service Control selects service configurations based on traffic percentage.

Returns
Type	Description
`Google\Cloud\ServiceManagement\V1\Rollout\TrafficPercentStrategy\|null`

hasTrafficPercentStrategy

setTrafficPercentStrategy

Google Service Control selects service configurations based on traffic percentage.

Parameter
Name	Description
`var`	`Google\Cloud\ServiceManagement\V1\Rollout\TrafficPercentStrategy`

Returns
Type	Description
`$this`

getDeleteServiceStrategy

The strategy associated with a rollout to delete a ManagedService.

Readonly.

Returns
Type	Description
`Google\Cloud\ServiceManagement\V1\Rollout\DeleteServiceStrategy\|null`

hasDeleteServiceStrategy

setDeleteServiceStrategy

The strategy associated with a rollout to delete a ManagedService.

Readonly.

Parameter
Name	Description
`var`	`Google\Cloud\ServiceManagement\V1\Rollout\DeleteServiceStrategy`

Returns
Type	Description
`$this`

getServiceName

The name of the service associated with this Rollout.

Returns
Type	Description
`string`

setServiceName

The name of the service associated with this Rollout.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStrategy

Returns
Type	Description
`string`