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.

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
strrollout_id
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'
google.protobuf.timestamp_pb2.Timestampcreate_time
Creation time of the rollout. Readonly.
strcreated_by
The user who created the Rollout. Readonly.
google.cloud.servicemanagement_v1.types.Rollout.RolloutStatusstatus
The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
google.cloud.servicemanagement_v1.types.Rollout.TrafficPercentStrategytraffic_percent_strategy
Google Service Control selects service configurations based on traffic percentage. This field is a member of `oneof`_ ``strategy``.
google.cloud.servicemanagement_v1.types.Rollout.DeleteServiceStrategydelete_service_strategy
The strategy associated with a rollout to delete a ``ManagedService``. Readonly. This field is a member of `oneof`_ ``strategy``.
strservice_name
The name of the service associated with this Rollout.

Inheritance

builtins.object > proto.message.Message > 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.

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
    }
  }
}