API documentation for saasplatform_saasservicemgmt_v1beta1.types package.
Classes
Aggregate
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.
Blueprint
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).
CreateReleaseRequest
The request structure for the CreateRelease method.
CreateRolloutKindRequest
The request structure for the CreateRolloutKind method.
CreateRolloutRequest
The request structure for the CreateRollout method.
CreateSaasRequest
The request structure for the CreateSaas method.
CreateTenantRequest
The request structure for the CreateTenant method.
CreateUnitKindRequest
The request structure for the CreateUnitKind method.
CreateUnitOperationRequest
The request structure for the CreateUnitOperation method.
CreateUnitRequest
The request structure for the CreateUnit method.
DeleteReleaseRequest
The request structure for the DeleteRelease method.
DeleteRolloutKindRequest
The request structure for the DeleteRolloutKind method.
DeleteRolloutRequest
The request structure for the DeleteRollout method.
DeleteSaasRequest
The request structure for the DeleteSaas method.
DeleteTenantRequest
The request structure for the DeleteTenant method.
DeleteUnitKindRequest
The request structure for the DeleteUnitKind method.
DeleteUnitOperationRequest
The request structure for the DeleteUnitOperation method.
DeleteUnitRequest
The request structure for the DeleteUnit method.
Dependency
Dependency represent a single dependency with another unit kind by alias.
Deprovision
Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.
ErrorBudget
The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused.
FromMapping
Output variables whose values will be passed on to dependencies
GetReleaseRequest
The request structure for the GetRelease method.
GetRolloutKindRequest
The request structure for the GetRolloutKind method.
GetRolloutRequest
The request structure for the GetRollout method.
GetSaasRequest
The request structure for the GetSaas method.
GetTenantRequest
The request structure for the GetTenant method.
GetUnitKindRequest
The request structure for the GetUnitKind method.
GetUnitOperationRequest
The request structure for the GetUnitOperation method.
GetUnitRequest
The request structure for the GetUnit method.
ListReleasesRequest
The request structure for the ListReleases method.
ListReleasesResponse
The response structure for the ListReleases method.
ListRolloutKindsRequest
The request structure for the ListRolloutKinds method.
ListRolloutKindsResponse
The response structure for the ListRolloutKinds method.
ListRolloutsRequest
The request structure for the ListRollouts method.
ListRolloutsResponse
The response structure for the ListRollouts method.
ListSaasRequest
The request structure for the ListSaas method.
ListSaasResponse
The response structure for the ListSaas method.
ListTenantsRequest
The request structure for the ListTenants method.
ListTenantsResponse
The response structure for the ListTenants method.
ListUnitKindsRequest
The request structure for the ListUnitKinds method.
ListUnitKindsResponse
The response structure for the ListUnitKinds method.
ListUnitOperationsRequest
The request structure for the ListUnitOperations method.
ListUnitOperationsResponse
The response structure for the ListUnitOperations method.
ListUnitsRequest
The request structure for the ListUnits method.
ListUnitsResponse
The response structure for the ListUnits method.
Location
Location information that the service is available in.
Provision
Provision is the unit operation that provision the underlying resources represented by a Unit. Can only execute if the Unit is not currently provisioned.
Release
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.
Rollout
Represents a single rollout execution and its results
RolloutAction
RolloutAction indicates the action to be performed on the Rollout.
RolloutControl
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
RolloutKind
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
RolloutStats
RolloutStats contains information about the progress of a rollout.
Saas
Saas is a representation of a SaaS service managed by the Producer.
Schedule
A time specification to schedule the maintenance.
Tenant
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"
ToMapping
Input variables whose values will be passed on to dependencies
Unit
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.
UnitCondition
UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
UnitDependency
Set of dependencies for this unit. Maximum 10.
UnitKind
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.
UnitOperation
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
UnitOperationCondition
UnitOperationCondition describes the status of an Unit Operation. UnitOperationCondition is individual components that contribute to an overall state.
UnitOperationErrorCategory
UnitOperationErrorCategory describes the error category of the unit operation.
UnitVariable
UnitVariable describes a parameter for a Unit.
UpdateReleaseRequest
The request structure for the UpdateRelease method.
UpdateRolloutKindRequest
The request structure for the UpdateRolloutKind method.
UpdateRolloutRequest
The request structure for the UpdateRollout method.
UpdateSaasRequest
The request structure for the UpdateSaas method.
UpdateTenantRequest
The request structure for the UpdateTenant method.
UpdateUnitKindRequest
The request structure for the UpdateUnitKind method.
UpdateUnitOperationRequest
The request structure for the UpdateUnitOperation method.
UpdateUnitRequest
The request structure for the UpdateUnit method.
Upgrade
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.
VariableMapping
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