Show / Hide Table of Contents

Namespace Google.Apis.SaaSServiceManagement.v1beta1.Data

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).

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.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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

GoogleCloudLocationLocation

A resource that represents a Google Cloud location.

ListLocationsResponse

The response message for Locations.ListLocations.

ListReleasesResponse

The response structure for the ListReleases method.

ListReplicationsInternalResponse

The response structure for the ListReplicationsInternal method.

ListRolloutKindsResponse

The response structure for the ListRolloutKinds method.

ListRolloutsResponse

The response structure for the ListRollouts method.

ListSaasResponse

The response structure for the ListSaas method.

ListTenantsResponse

The response structure for the ListTenants method.

ListUnitKindsResponse

The response structure for the ListUnitKinds method.

ListUnitOperationsResponse

The response structure for the ListUnitOperations method.

ListUnitsResponse

The response structure for the ListUnits method.

Location

Location information that the service is available in.

MaintenanceSettings

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.

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.

ReleaseRequirements

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

ReplicationInternal

ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.

ReplicationStats

ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.

Rollout

Represents a single rollout execution and its results

RolloutControl

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

RolloutKind

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

RolloutStats

RolloutStats contains information about the progress of a rollout.

RunRolloutActionParams

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

Saas

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

Schedule

A time specification to schedule the maintenance.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

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

UnitOperationCondition

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

UnitVariable

UnitVariable describes a parameter for a Unit.

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

In this article
Back to top Generated by DocFX