Reference documentation and code samples for the Google Cloud Saas Platform Saas Service Mgmt V1 Client class RolloutKind.
An object that describes various settings of Rollout execution. Includes built-in and customizable policies.
Generated from protobuf message google.cloud.saasplatform.saasservicemgmt.v1.RolloutKind
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}/rolloutKinds/{rollout_kind_id}" |
↳ unit_kind |
string
Optional. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts. |
↳ rollout_orchestration_strategy |
string
Optional. The strategy used for executing a Rollout. This is a required field. 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 associated UnitKind's Saas Locations. |
↳ unit_filter |
string
Optional. CEL 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. |
↳ update_unit_kind_strategy |
int
Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start. |
↳ error_budget |
ErrorBudget
Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered. |
↳ unit_update_pacing |
UnitUpdatePacing
Optional. Settings for controlling the pacing of rollouts i.e. the number of units to be rolled out in parallel in a region. |
↳ 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. |
getName
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitKind
Optional. Immutable. UnitKind that this rollout kind corresponds to.
Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUnitKind
Optional. Immutable. UnitKind that this rollout kind corresponds to.
Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRolloutOrchestrationStrategy
Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRolloutOrchestrationStrategy
Optional. The strategy used for executing a Rollout. This is a required field.
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 associated UnitKind's Saas Locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitFilter
Optional. CEL 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUnitFilter
Optional. CEL 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateUnitKindStrategy
Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type UpdateUnitKindStrategy. |
setUpdateUnitKindStrategy
Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type UpdateUnitKindStrategy. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrorBudget
Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
| Returns | |
|---|---|
| Type | Description |
ErrorBudget|null |
|
hasErrorBudget
clearErrorBudget
setErrorBudget
Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
| Parameter | |
|---|---|
| Name | Description |
var |
ErrorBudget
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitUpdatePacing
Optional. Settings for controlling the pacing of rollouts i.e. the number of units to be rolled out in parallel in a region.
| Returns | |
|---|---|
| Type | Description |
UnitUpdatePacing|null |
|
hasUnitUpdatePacing
clearUnitUpdatePacing
setUnitUpdatePacing
Optional. Settings for controlling the pacing of rollouts i.e. the number of units to be rolled out in parallel in a region.
| Parameter | |
|---|---|
| Name | Description |
var |
UnitUpdatePacing
|
| 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 |
|