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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Creation time of the rollout. Readonly.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Creation time of the rollout. Readonly.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCreatedBy

The user who created the Rollout. Readonly.

Returns
TypeDescription
string

setCreatedBy

The user who created the Rollout. Readonly.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getTrafficPercentStrategy

Google Service Control selects service configurations based on traffic percentage.

Returns
TypeDescription
Google\Cloud\ServiceManagement\V1\Rollout\TrafficPercentStrategy|null

hasTrafficPercentStrategy

setTrafficPercentStrategy

Google Service Control selects service configurations based on traffic percentage.

Parameter
NameDescription
var Google\Cloud\ServiceManagement\V1\Rollout\TrafficPercentStrategy
Returns
TypeDescription
$this

getDeleteServiceStrategy

The strategy associated with a rollout to delete a ManagedService.

Readonly.

Returns
TypeDescription
Google\Cloud\ServiceManagement\V1\Rollout\DeleteServiceStrategy|null

hasDeleteServiceStrategy

setDeleteServiceStrategy

The strategy associated with a rollout to delete a ManagedService.

Readonly.

Parameter
NameDescription
var Google\Cloud\ServiceManagement\V1\Rollout\DeleteServiceStrategy
Returns
TypeDescription
$this

getServiceName

The name of the service associated with this Rollout.

Returns
TypeDescription
string

setServiceName

The name of the service associated with this Rollout.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStrategy

Returns
TypeDescription
string