Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class Rollout.
Represents a single rollout execution and its results
Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.Rollout
Namespace
Google \ Cloud \ SaasPlatform \ SaasServiceMgmt \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}" |
↳ release |
string
Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified. |
↳ start_time |
Google\Protobuf\Timestamp
Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet. |
↳ end_time |
Google\Protobuf\Timestamp
Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. |
↳ state |
int
Output only. Current state of the rollout. |
↳ state_message |
string
Output only. Human readable message indicating details about the last state transition. |
↳ state_transition_time |
Google\Protobuf\Timestamp
Optional. Output only. The time when the rollout transitioned into its current state. |
↳ root_rollout |
string
Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" |
↳ parent_rollout |
string
Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}" |
↳ rollout_orchestration_strategy |
string
Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations. |
↳ unit_filter |
string
Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used. |
↳ rollout_kind |
string
Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to. |
↳ stats |
RolloutStats
Optional. Output only. Details about the progress of the rollout. |
↳ control |
RolloutControl
Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state. |
↳ effective_unit_filter |
string
Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. |
↳ annotations |
array|Google\Protobuf\Internal\MapField
Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations |
↳ uid |
string
Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4. |
↳ etag |
string
Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value. |
↳ delete_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation). |
getName
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRelease
Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRelease
Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Current state of the rollout.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type RolloutState. |
setState
Output only. Current state of the rollout.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type RolloutState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateMessage
Output only. Human readable message indicating details about the last state transition.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStateMessage
Output only. Human readable message indicating details about the last state transition.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStateTransitionTime
Optional. Output only. The time when the rollout transitioned into its current state.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStateTransitionTime
clearStateTransitionTime
setStateTransitionTime
Optional. Output only. The time when the rollout transitioned into its current state.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRootRollout
Optional. Output only. The root rollout that this rollout is stemming from.
The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setRootRollout
Optional. Output only. The root rollout that this rollout is stemming from.
The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParentRollout
Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setParentRollout
Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRolloutOrchestrationStrategy
Optional. The strategy used for executing this Rollout.
This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control
- "Google.Cloud.Simple.AllAtOnce"
- "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRolloutOrchestrationStrategy
Optional. The strategy used for executing this Rollout.
This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control
- "Google.Cloud.Simple.AllAtOnce"
- "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitFilter
Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUnitFilter
Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRolloutKind
Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRolloutKind
Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStats
Optional. Output only. Details about the progress of the rollout.
| Returns | |
|---|---|
| Type | Description |
RolloutStats|null |
|
hasStats
clearStats
setStats
Optional. Output only. Details about the progress of the rollout.
| Parameter | |
|---|---|
| Name | Description |
var |
RolloutStats
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getControl
Optional. Requested change to the execution of this rollout.
Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
| Returns | |
|---|---|
| Type | Description |
RolloutControl|null |
|
hasControl
clearControl
setControl
Optional. Requested change to the execution of this rollout.
Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
| Parameter | |
|---|---|
| Name | Description |
var |
RolloutControl
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEffectiveUnitFilter
Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEffectiveUnitFilter
Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. The labels on the resource, which can be used for categorization.
similar to Kubernetes resource labels.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotations
Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/user-guide/annotations
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setAnnotations
Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/user-guide/annotations
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp when the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value.
Changes to a resource made by the service should refresh this value.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value.
Changes to a resource made by the service should refresh this value.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteTime
Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|