googleapis
Version:
Google APIs Client Library for Node.js
1,002 lines • 311 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace saasservicemgmt_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* App Lifecycle Manager API
*
* Model, deploy, and operate your SaaS at scale.
*
* @example
* ```js
* const {google} = require('googleapis');
* const saasservicemgmt = google.saasservicemgmt('v1');
* ```
*/
export class Saasservicemgmt {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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.
*/
export interface Schema$Aggregate {
/**
* Required. Number of records in the group.
*/
count?: number | null;
/**
* Required. Group by which to aggregate.
*/
group?: string | null;
}
/**
* 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).
*/
export interface Schema$Blueprint {
/**
* Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc.
*/
engine?: string | null;
/**
* Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set).
*/
package?: string | null;
/**
* Output only. Version metadata if present on the blueprint.
*/
version?: string | null;
}
/**
* A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).
*/
export interface Schema$Decimal {
/**
* The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -\> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -\> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -\> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -\> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-\> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' \}; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
*/
value?: string | null;
}
/**
* Dependency represent a single dependency with another unit kind by alias.
*/
export interface Schema$Dependency {
/**
* Required. An alias for the dependency. Used for input variable mapping.
*/
alias?: string | null;
/**
* Required. Immutable. The unit kind of the dependency.
*/
unitKind?: string | null;
}
/**
* Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.
*/
export interface Schema$Deprovision {
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused.
*/
export interface Schema$ErrorBudget {
/**
* Optional. The maximum number of failed units allowed in a location without pausing the rollout.
*/
allowedCount?: number | null;
/**
* Optional. The maximum percentage of units allowed to fail (0, 100] within a location without pausing the rollout.
*/
allowedPercentage?: number | null;
}
/**
* FlagUpdate is a UnitOperation that pushes new flag values to Units.
*/
export interface Schema$FlagUpdate {
/**
* Required. Flag release being applied by UnitOperation.
*/
flagRelease?: string | null;
}
/**
* Output variables whose values will be passed on to dependencies
*/
export interface Schema$FromMapping {
/**
* Required. Alias of the dependency that the outputVariable will pass its value to
*/
dependency?: string | null;
/**
* Required. Name of the outputVariable on the dependency
*/
outputVariable?: string | null;
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$GoogleCloudLocationLocation {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$GoogleCloudLocationLocation[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The response structure for the ListReleases method.
*/
export interface Schema$ListReleasesResponse {
/**
* If present, the next page token can be provided to a subsequent ListReleases call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting releases.
*/
releases?: Schema$Release[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListRolloutKinds method.
*/
export interface Schema$ListRolloutKindsResponse {
/**
* If present, the next page token can be provided to a subsequent ListRolloutKinds call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting rollout kinds.
*/
rolloutKinds?: Schema$RolloutKind[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListRollouts method.
*/
export interface Schema$ListRolloutsResponse {
/**
* If present, the next page token can be provided to a subsequent ListRollouts call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting rollouts.
*/
rollouts?: Schema$Rollout[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListSaas method.
*/
export interface Schema$ListSaasResponse {
/**
* If present, the next page token can be provided to a subsequent ListSaas call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting saas.
*/
saas?: Schema$Saas[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListTenants method.
*/
export interface Schema$ListTenantsResponse {
/**
* If present, the next page token can be provided to a subsequent ListTenants call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting tenants.
*/
tenants?: Schema$Tenant[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListUnitKinds method.
*/
export interface Schema$ListUnitKindsResponse {
/**
* If present, the next page token can be provided to a subsequent ListUnitKinds call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting unit kinds.
*/
unitKinds?: Schema$UnitKind[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListUnitOperations method.
*/
export interface Schema$ListUnitOperationsResponse {
/**
* If present, the next page token can be provided to a subsequent ListUnitOperations call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting unit operations.
*/
unitOperations?: Schema$UnitOperation[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response structure for the ListUnits method.
*/
export interface Schema$ListUnitsResponse {
/**
* If present, the next page token can be provided to a subsequent ListUnits call to list the next page. If empty, there are no more pages.
*/
nextPageToken?: string | null;
/**
* The resulting units.
*/
units?: Schema$Unit[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Location information that the service is available in.
*/
export interface Schema$Location {
/**
* Optional. Name of location.
*/
name?: string | null;
}
/**
* 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.
*/
export interface Schema$MaintenanceSettings {
/**
* Optional. If present, it fixes the release on the unit until the given time; i.e. changes to the release field will be rejected. Rollouts should and will also respect this by not requesting an upgrade in the first place.
*/
pinnedUntilTime?: string | null;
}
/**
* Provision is the unit operation that provision the underlying resources represented by a Unit. Can only execute if the Unit is not currently provisioned.
*/
export interface Schema$Provision {
/**
* Optional. Set of input variables. Maximum 100. (optional)
*/
inputVariables?: Schema$UnitVariable[];
/**
* Optional. Reference to the Release object to use for the Unit. (optional).
*/
release?: string | null;
}
/**
* 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.
*/
export interface Schema$Release {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Optional. Blueprints are OCI Images that contain all of the artifacts needed to provision a unit.
*/
blueprint?: Schema$Blueprint;
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. Mapping of input variables to default values. Maximum 100
*/
inputVariableDefaults?: Schema$UnitVariable[];
/**
* Optional. Output only. List of input variables declared on the blueprint and can be present with their values on the unit spec
*/
inputVariables?: Schema$UnitVariable[];
/**
* Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/releases/{release\}"
*/
name?: string | null;
/**
* Optional. Output only. List of output variables declared on the blueprint and can be present with their values on the unit status
*/
outputVariables?: Schema$UnitVariable[];
/**
* Optional. Set of requirements to be fulfilled on the Unit when using this Release.
*/
releaseRequirements?: Schema$ReleaseRequirements;
/**
* Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Required. Immutable. Reference to the UnitKind this Release corresponds to (required and immutable once created).
*/
unitKind?: string | null;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
}
/**
* Set of requirements to be fulfilled on the Unit when using this Release.
*/
export interface Schema$ReleaseRequirements {
/**
* Optional. A list of releases from which a unit can be upgraded to this one (optional). If left empty no constraints will be applied. When provided, unit upgrade requests to this release will check and enforce this constraint.
*/
upgradeableFromReleases?: string[] | null;
}
/**
* Represents a single rollout execution and its results
*/
export interface Schema$Rollout {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -\> SUCCEEDED or RUNNING -\> FAILED). Requests can only be made when the Rollout is in a non-terminal state.
*/
control?: Schema$RolloutControl;
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).
*/
deleteTime?: string | null;
/**
* Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.
*/
effectiveUnitFilter?: string | null;
/**
* Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.
*/
endTime?: string | null;
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted.
*/
flagRelease?: string | null;
/**
* Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/rollout/{rollout_id\}"
*/
name?: string | null;
/**
* Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/rollouts/{rollout_id\}"
*/
parentRollout?: string | null;
/**
* Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.
*/
release?: string | null;
/**
* Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.
*/
rolloutKind?: string | null;
/**
* Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.
*/
rolloutOrchestrationStrategy?: string | null;
/**
* Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/rollouts/{rollout_id\}"
*/
rootRollout?: string | null;
/**
* Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.
*/
startTime?: string | null;
/**
* Output only. Current state of the rollout.
*/
state?: string | null;
/**
* Output only. Human readable message indicating details about the last state transition.
*/
stateMessage?: string | null;
/**
* Optional. Output only. The time when the rollout transitioned into its current state.
*/
stateTransitionTime?: string | null;
/**
* Optional. Output only. Details about the progress of the rollout.
*/
stats?: Schema$RolloutStats;
/**
* Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.
*/
unitFilter?: string | null;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
}
/**
* RolloutControl provides a way to request a change to the execution of a Rollout by pausing or canceling it.
*/
export interface Schema$RolloutControl {
/**
* Required. Action to be performed on the Rollout. The default behavior is to run the rollout until it naturally reaches a terminal state.
*/
action?: string | null;
/**
* Optional. Parameters for the RUN action. It is an error to specify this if the RolloutAction is not set to RUN. By default, the rollout will retry failed operations when resumed.
*/
runParams?: Schema$RunRolloutActionParams;
}
/**
* An object that describes various settings of Rollout execution. Includes built-in and customizable policies.
*/
export interface Schema$RolloutKind {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.
*/
errorBudget?: Schema$ErrorBudget;
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/rolloutKinds/{rollout_kind_id\}"
*/
name?: string | null;
/**
* Optional. The strategy used for executing a Rollout. This is a required field. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the associated UnitKind's Saas Locations.
*/
rolloutOrchestrationStrategy?: string | null;
/**
* Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout.
*/
unitFilter?: string | null;
/**
* Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.
*/
unitKind?: string | null;
/**
* Optional. Settings for controlling the pacing of rollouts i.e. the number of units to be rolled out in parallel in a region.
*/
unitUpdatePacing?: Schema$UnitUpdatePacing;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
/**
* Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.
*/
updateUnitKindStrategy?: string | null;
}
/**
* RolloutStats contains information about the progress of a rollout.
*/
export interface Schema$RolloutStats {
/**
* Optional. Output only. Estimated number of units based. The estimation is computed upon creation of the rollout.
*/
estimatedTotalUnitCount?: string | null;
/**
* Optional. Output only. Unordered list. A breakdown of the progress of operations triggered by the rollout. Provides a count of Operations by their state. This can be used to determine the number of units which have been updated, or are scheduled to be updated. There will be at most one entry per group. Possible values for operation groups are: - "SCHEDULED" - "PENDING" - "RUNNING" - "SUCCEEDED" - "FAILED" - "CANCELLED"
*/
operationsByState?: Schema$Aggregate[];
}
/**
* Parameters for the RUN action controlling the behavior of the rollout when it is resumed from a PAUSED state.
*/
export interface Schema$RunRolloutActionParams {
/**
* Required. If true, the rollout will retry failed operations when resumed. This is applicable only the current state of the Rollout is PAUSED and the requested action is RUN.
*/
retryFailedOperations?: boolean | null;
}
/**
* Saas is a representation of a SaaS service managed by the Producer.
*/
export interface Schema$Saas {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Output only. A set of conditions which indicate the various conditions this resource can have.
*/
conditions?: Schema$SaasCondition[];
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Output only. If the state is FAILED, the corresponding error code and message. Defaults to code=OK for all other states.
*/
error?: Schema$Status;
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. List of locations that the service is available in. Rollout refers to the list to generate a rollout plan.
*/
locations?: Schema$Location[];
/**
* Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/saas/{saas\}"
*/
name?: string | null;
/**
* Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty.
*/
state?: string | null;
/**
* Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
}
/**
* SaasCondition describes the status of a Saas.
*/
export interface Schema$SaasCondition {
/**
* Required. Last time the condition transited from one status to another.
*/
lastTransitionTime?: string | null;
/**
* Required. Human readable message indicating details about the last transition.
*/
message?: string | null;
/**
* Required. Brief reason for the condition's last transition.
*/
reason?: string | null;
/**
* Required. Status of the condition.
*/
status?: string | null;
/**
* Required. Type of the condition.
*/
type?: string | null;
}
/**
* A time specification to schedule the maintenance.
*/
export interface Schema$Schedule {
/**
* Optional. Start of operation. If not set, will be set to the start of the next window. (optional)
*/
startTime?: string | null;
}
/**
* 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](https://github.com/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](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* 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"
*/
export interface Schema$Tenant {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).
*/
consumerResource?: string | null;
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/tenants/{tenant\}"
*/
name?: string | null;
/**
* Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model.
*/
saas?: string | null;
/**
* Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
}
/**
* Input variables whose values will be passed on to dependencies
*/
export interface Schema$ToMapping {
/**
* Required. Alias of the dependency that the inputVariable will pass its value to
*/
dependency?: string | null;
/**
* Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not
*/
ignoreForLookup?: boolean | null;
/**
* Required. Name of the inputVariable on the dependency
*/
inputVariable?: string | null;
}
/**
* 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.
*/
export interface Schema$Unit {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Optional. Output only. A set of conditions which indicate the various conditions this resource can have.
*/
conditions?: Schema$UnitCondition[];
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. Output only. Set of dependencies for this unit. Maximum 10.
*/
dependencies?: Schema$UnitDependency[];
/**
* Optional. Output only. List of Units that depend on this unit. Unit can only be deprovisioned if this list is empty. Maximum 1000.
*/
dependents?: Schema$UnitDependency[];
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. Output only. Flag revisions used by this Unit.
*/
flagRevisions?: string[] | null;
/**
* Optional. Output only. Indicates the current input variables deployed by the unit
*/
inputVariables?: Schema$UnitVariable[];
/**
* Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. 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.
*/
maintenance?: Schema$MaintenanceSettings;
/**
* Optional. Immutable. Indicates whether the Unit life cycle is controlled by the user or by the system. Immutable once created.
*/
managementMode?: string | null;
/**
* Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project\}/locations/{location\}/units/{unit\}"
*/
name?: string | null;
/**
* Optional. Output only. List of concurrent UnitOperations that are operating on this Unit.
*/
ongoingOperations?: string[] | null;
/**
* Optional. Output only. Set of key/value pairs corresponding to output variables from execution of actuation templates. The variables are declared in actuation configs (e.g in helm chart or terraform) and the values are fetched and returned by the actuation engine upon completion of execution.
*/
outputVariables?: Schema$UnitVariable[];
/**
* Optional. Output only. List of pending (wait to be executed) UnitOperations for this unit.
*/
pendingOperations?: string[] | null;
/**
* Optional. Output only. The current Release object for this Unit.
*/
release?: string | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Output only. Indicates whether the resource location satisfies Zone Separation constraints. This is false by default.
*/
satisfiesPzs?: boolean | null;
/**
* Optional. Output only. List of scheduled UnitOperations for this unit.
*/
scheduledOperations?: string[] | null;
/**
* Optional. Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
*/
state?: string | null;
/**
* Optional. Output only. If set, indicates the time when the system will start removing the unit.
*/
systemCleanupAt?: string | null;
/**
* Optional. Output only. Indicates the system managed state of the unit.
*/
systemManagedState?: string | null;
/**
* Optional. Reference to the Saas Tenant resource this unit belongs to. This for example informs the maintenance policies to use for scheduling future updates on a unit. (optional and immutable once created)
*/
tenant?: string | null;
/**
* Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
*/
uid?: string | null;
/**
* Optional. Reference to the UnitKind this Unit belongs to. Immutable once set.
*/
unitKind?: string | null;
/**
* Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
*/
updateTime?: string | null;
}
/**
* UnitCondition describes the status of an Unit. UnitCondition is individual components that contribute to an overall state.
*/
export interface Schema$UnitCondition {
/**
* Required. Last time the condition transited from one status to another.
*/
lastTransitionTime?: string | null;
/**
* Required. Human readable message indicating details about the last transition.
*/
message?: string | null;
/**
* Required. Brief reason for the condition's last transition.
*/
reason?: string | null;
/**
* Required. Status of the condition.
*/
status?: string | null;
/**
* Required. Type of the condition.
*/
type?: string | null;
}
/**
* Set of dependencies for this unit. Maximum 10.
*/
export interface Schema$UnitDependency {
/**
* Output only. Alias for the name of the dependency.
*/
alias?: string | null;
/**
* Output only. A reference to the Unit object.
*/
unit?: string | null;
}
/**
* 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.
*/
export interface Schema$UnitKind {
/**
* Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
*/
annotations?: {
[key: string]: string;
} | null;
/**
* Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents.
*/
boundaryType?: string | null;
/**
* Output only. The timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.
*/
defaultFlagRevisions?: string[] | null;
/**
* Optional. A reference to the Release object to use as default for creating new units of this UnitKind (optional). If not specified, a new unit must explicitly reference which release to use for its creation.
*/
defaultRelease?: string | null;
/**
* Optional. Immutable. List of other unit kinds that this release will depend on. Dependencies will be automatically provisioned if not found. Maximum 10.
*/
dependencies?: Schema$Dependency[];
/**
* Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
*/
etag?: string | null;
/**
* Optional. List of inputVariables for this release that will either be retrieved from a dependency's outputVariables, or will be passed on to a dependency's inputVariables. Maximum 100.
*/
input