Class Rollout (1.5.1)

Stay organized with collections Save and categorize content based on your preferences.
Rollout(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
rollout_id str
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 , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
create_time google.protobuf.timestamp_pb2.Timestamp
Creation time of the rollout. Readonly.
created_by str
The user who created the Rollout. Readonly.
status google.cloud.servicemanagement_v1.types.Rollout.RolloutStatus
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.types.Rollout.TrafficPercentStrategy
Google Service Control selects service configurations based on traffic percentage. This field is a member of oneof_ strategy.
delete_service_strategy google.cloud.servicemanagement_v1.types.Rollout.DeleteServiceStrategy
The strategy associated with a rollout to delete a ManagedService. Readonly. This field is a member of oneof_ strategy.
service_name str
The name of the service associated with this Rollout.

Classes

DeleteServiceStrategy

DeleteServiceStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

RolloutStatus

RolloutStatus(value)

Status of a Rollout.

Values: ROLLOUT_STATUS_UNSPECIFIED (0): No status specified. IN_PROGRESS (1): The Rollout is in progress. SUCCESS (2): The Rollout has completed successfully. CANCELLED (3): The Rollout has been cancelled. This can happen if you have overlapping Rollout pushes, and the previous ones will be cancelled. FAILED (4): The Rollout has failed and the rollback attempt has failed too. PENDING (5): The Rollout has not started yet and is pending for execution. FAILED_ROLLED_BACK (6): The Rollout has failed and rolled back to the previous successful Rollout.

TrafficPercentStrategy

TrafficPercentStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version.

One example of how to gradually rollout a new service configuration using this strategy: Day 1

::

Rollout {
  id: "example.googleapis.com/rollout_20160206"
  traffic_percent_strategy {
    percentages: {
      "example.googleapis.com/20160201": 70.00
      "example.googleapis.com/20160206": 30.00
    }
  }
}

Day 2

::

Rollout {
  id: "example.googleapis.com/rollout_20160207"
  traffic_percent_strategy: {
    percentages: {
      "example.googleapis.com/20160206": 100.00
    }
  }
}