Package Classes (0.1.0)

Manages the deployment of SaaS services.

Manages the deployment of SaaS services.

A pager for iterating through list_releases requests.

This class thinly wraps an initial ListReleasesResponse object, and provides an __aiter__ method to iterate through its releases field.

If there are more pages, the __aiter__ method will make additional ListReleases requests and continue to iterate through the releases field on the corresponding responses.

All the usual ListReleasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_releases requests.

This class thinly wraps an initial ListReleasesResponse object, and provides an __iter__ method to iterate through its releases field.

If there are more pages, the __iter__ method will make additional ListReleases requests and continue to iterate through the releases field on the corresponding responses.

All the usual ListReleasesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_saas requests.

This class thinly wraps an initial ListSaasResponse object, and provides an __aiter__ method to iterate through its saas field.

If there are more pages, the __aiter__ method will make additional ListSaas requests and continue to iterate through the saas field on the corresponding responses.

All the usual ListSaasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_saas requests.

This class thinly wraps an initial ListSaasResponse object, and provides an __iter__ method to iterate through its saas field.

If there are more pages, the __iter__ method will make additional ListSaas requests and continue to iterate through the saas field on the corresponding responses.

All the usual ListSaasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tenants requests.

This class thinly wraps an initial ListTenantsResponse object, and provides an __aiter__ method to iterate through its tenants field.

If there are more pages, the __aiter__ method will make additional ListTenants requests and continue to iterate through the tenants field on the corresponding responses.

All the usual ListTenantsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tenants requests.

This class thinly wraps an initial ListTenantsResponse object, and provides an __iter__ method to iterate through its tenants field.

If there are more pages, the __iter__ method will make additional ListTenants requests and continue to iterate through the tenants field on the corresponding responses.

All the usual ListTenantsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_unit_kinds requests.

This class thinly wraps an initial ListUnitKindsResponse object, and provides an __aiter__ method to iterate through its unit_kinds field.

If there are more pages, the __aiter__ method will make additional ListUnitKinds requests and continue to iterate through the unit_kinds field on the corresponding responses.

All the usual ListUnitKindsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_unit_kinds requests.

This class thinly wraps an initial ListUnitKindsResponse object, and provides an __iter__ method to iterate through its unit_kinds field.

If there are more pages, the __iter__ method will make additional ListUnitKinds requests and continue to iterate through the unit_kinds field on the corresponding responses.

All the usual ListUnitKindsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_unit_operations requests.

This class thinly wraps an initial ListUnitOperationsResponse object, and provides an __aiter__ method to iterate through its unit_operations field.

If there are more pages, the __aiter__ method will make additional ListUnitOperations requests and continue to iterate through the unit_operations field on the corresponding responses.

All the usual ListUnitOperationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_unit_operations requests.

This class thinly wraps an initial ListUnitOperationsResponse object, and provides an __iter__ method to iterate through its unit_operations field.

If there are more pages, the __iter__ method will make additional ListUnitOperations requests and continue to iterate through the unit_operations field on the corresponding responses.

All the usual ListUnitOperationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_units requests.

This class thinly wraps an initial ListUnitsResponse object, and provides an __aiter__ method to iterate through its units field.

If there are more pages, the __aiter__ method will make additional ListUnits requests and continue to iterate through the units field on the corresponding responses.

All the usual ListUnitsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_units requests.

This class thinly wraps an initial ListUnitsResponse object, and provides an __iter__ method to iterate through its units field.

If there are more pages, the __iter__ method will make additional ListUnits requests and continue to iterate through the units field on the corresponding responses.

All the usual ListUnitsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Manages the rollout of SaaS services.

Manages the rollout of SaaS services.

A pager for iterating through list_rollout_kinds requests.

This class thinly wraps an initial ListRolloutKindsResponse object, and provides an __aiter__ method to iterate through its rollout_kinds field.

If there are more pages, the __aiter__ method will make additional ListRolloutKinds requests and continue to iterate through the rollout_kinds field on the corresponding responses.

All the usual ListRolloutKindsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rollout_kinds requests.

This class thinly wraps an initial ListRolloutKindsResponse object, and provides an __iter__ method to iterate through its rollout_kinds field.

If there are more pages, the __iter__ method will make additional ListRolloutKinds requests and continue to iterate through the rollout_kinds field on the corresponding responses.

All the usual ListRolloutKindsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rollouts requests.

This class thinly wraps an initial ListRolloutsResponse object, and provides an __aiter__ method to iterate through its rollouts field.

If there are more pages, the __aiter__ method will make additional ListRollouts requests and continue to iterate through the rollouts field on the corresponding responses.

All the usual ListRolloutsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rollouts requests.

This class thinly wraps an initial ListRolloutsResponse object, and provides an __iter__ method to iterate through its rollouts field.

If there are more pages, the __iter__ method will make additional ListRollouts requests and continue to iterate through the rollouts field on the corresponding responses.

All the usual ListRolloutsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Represents the aggregation of a set of population of like records by a certain group. For example, a collection of unit counts can be aggregated and grouped by their state.

Blueprints are OCI Images that contain all of the artifacts needed to provision a unit. Metadata such as, type of the engine used to actuate the blueprint (e.g. terraform, helm etc) and version will come from the image manifest. If the hostname is omitted, it will be assumed to be the regional path to Artifact Registry (eg. us-east1-docker.pkg.dev).

The request structure for the CreateRelease method.

The request structure for the CreateRolloutKind method.

The request structure for the CreateRollout method.

The request structure for the CreateSaas method.

The request structure for the CreateTenant method.

The request structure for the CreateUnitKind method.

The request structure for the CreateUnitOperation method.

The request structure for the CreateUnit method.

The request structure for the DeleteRelease method.

The request structure for the DeleteRolloutKind method.

The request structure for the DeleteRollout method.

The request structure for the DeleteSaas method.

The request structure for the DeleteTenant method.

The request structure for the DeleteUnitKind method.

The request structure for the DeleteUnitOperation method.

The request structure for the DeleteUnit method.

Dependency represent a single dependency with another unit kind by alias.

Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.

The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused.

Output variables whose values will be passed on to dependencies

The request structure for the GetRelease method.

The request structure for the GetRolloutKind method.

The request structure for the GetRollout method.

The request structure for the GetSaas method.

The request structure for the GetTenant method.

The request structure for the GetUnitKind method.

The request structure for the GetUnitOperation method.

The request structure for the GetUnit method.

The request structure for the ListReleases method.

The response structure for the ListReleases method.

The request structure for the ListRolloutKinds method.

The response structure for the ListRolloutKinds method.

The request structure for the ListRollouts method.

The response structure for the ListRollouts method.

The request structure for the ListSaas method.

The response structure for the ListSaas method.

The request structure for the ListTenants method.

The response structure for the ListTenants method.

The request structure for the ListUnitKinds method.

The response structure for the ListUnitKinds method.

The request structure for the ListUnitOperations method.

The response structure for the ListUnitOperations method.

The request structure for the ListUnits method.

The response structure for the ListUnits method.

Location information that the service is available in.

Provision is the unit operation that provision the underlying resources represented by a Unit. Can only execute if the Unit is not currently provisioned.

A new version to be propagated and deployed to units. This includes pointers to packaged blueprints for actuation (e.g Helm or Terraform configuration packages) via artifact registry.

The abstract base class for a message.

The abstract base class for a message.

Set of requirements to be fulfilled on the Unit when using this Release.

Represents a single rollout execution and its results

The abstract base class for a message.

The abstract base class for a message.

The current state of the rollout.

RolloutAction indicates the action to be performed on the Rollout.

RolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it.

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

Parameters for the RUN action controlling the behavior of the rollout when it is resumed from a PAUSED state.

An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.

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

The abstract base class for a message.

The abstract base class for a message.

RolloutStats contains information about the progress of a rollout.

Saas is a representation of a SaaS service managed by the Producer.

The abstract base class for a message.

The abstract base class for a message.

A time specification to schedule the maintenance.

Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer.

Example:

::

tenant: name: "projects/svc1/locations/loc/tenants/inst-068afff8" consumer_resource: "projects/gshoe/locations/loc/shoes/black-shoe"

The abstract base class for a message.

The abstract base class for a message.

Input variables whose values will be passed on to dependencies

A unit of deployment that has its lifecycle via a CRUD API using an actuation engine under the hood (e.g. based on Terraform, Helm or a custom implementation provided by a service producer). A building block of a SaaS Tenant.

The abstract base class for a message.

The abstract base class for a message.

Captures requested directives for performing future maintenance on the unit. This includes a request for the unit to skip maintenance for a period of time and remain pinned to its current release as well as controls for postponing maintenance scheduled in future.

ManagementMode describes who is responsible for the management of the unit.

UnitState annotates what is the current state of the unit itself.

UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.

Enumeration of condition statuses.

Enumeration of condition types.

Set of dependencies for this unit. Maximum 10.

Definition of a Unit. Units belonging to the same UnitKind are managed together; for example they follow the same release model (blueprints, versions etc.) and are typically rolled out together.

The abstract base class for a message.

The abstract base class for a message.

UnitOperation encapsulates the intent of changing/interacting with the service component represented by the specific Unit. Multiple UnitOperations can be created (requested) and scheduled in the future, however only one will be allowed to execute at a time (that can change in the future for non-mutating operations).

UnitOperations allow different actors interacting with the same unit to focus only on the change they have requested.

This is a base object that contains the common fields in all unit operations. Next: 19

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

The abstract base class for a message.

The abstract base class for a message.

UnitOperationState describes the current state of the unit operation.

UnitOperationCondition describes the status of an Unit Operation. UnitOperationCondition is individual components that contribute to an overall state.

Enumeration of condition statuses.

Enumeration of condition types.

UnitOperationErrorCategory describes the error category of the unit operation.

UnitVariable describes a parameter for a Unit.

Enumeration of variable types.

The request structure for the UpdateRelease method.

The request structure for the UpdateRolloutKind method.

The request structure for the UpdateRollout method.

The request structure for the UpdateSaas method.

The request structure for the UpdateTenant method.

The request structure for the UpdateUnitKind method.

The request structure for the UpdateUnitOperation method.

The request structure for the UpdateUnit method.

Upgrade is the unit operation that upgrades a provisioned unit, which may also include the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.

Mapping of input variables to their respective output variable for depedenencies

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

API documentation for saasplatform_saasservicemgmt_v1beta1.services.saas_deployments.pagers module.

API documentation for saasplatform_saasservicemgmt_v1beta1.services.saas_rollouts.pagers module.