googleapis
Version:
Google APIs Client Library for Node.js
938 lines • 281 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 deploymentmanager_alpha {
export interface Options extends GlobalOptions {
version: 'alpha';
}
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;
}
/**
* Cloud Deployment Manager V2 API
*
* The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.
*
* @example
* ```js
* const {google} = require('googleapis');
* const deploymentmanager = google.deploymentmanager('alpha');
* ```
*/
export class Deploymentmanager {
context: APIRequestContext;
compositeTypes: Resource$Compositetypes;
deployments: Resource$Deployments;
manifests: Resource$Manifests;
operations: Resource$Operations;
resources: Resource$Resources;
typeProviders: Resource$Typeproviders;
types: Resource$Types;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Async options that determine when a resource should finish.
*/
export interface Schema$AsyncOptions {
/**
* Method regex where this policy will apply.
*/
methodMatch?: string | null;
/**
* Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed.
*/
pollingOptions?: Schema$PollingOptions;
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* BaseType that describes a service-backed Type.
*/
export interface Schema$BaseType {
/**
* Allows resource handling overrides for specific collections
*/
collectionOverrides?: Schema$CollectionOverride[];
/**
* Credential used when interacting with this type.
*/
credential?: Schema$Credential;
/**
* Descriptor Url for the this type.
*/
descriptorUrl?: string | null;
/**
* Options to apply when handling any resources in this service.
*/
options?: Schema$Options;
}
/**
* Basic Auth used as a credential.
*/
export interface Schema$BasicAuth {
password?: string | null;
user?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
export interface Schema$BulkInsertOperationStatus {
/**
* [Output Only] Count of VMs successfully created so far.
*/
createdVmCount?: number | null;
/**
* [Output Only] Count of VMs that got deleted during rollback.
*/
deletedVmCount?: number | null;
/**
* [Output Only] Count of VMs that started creating but encountered an error.
*/
failedToCreateVmCount?: number | null;
/**
* [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
*/
status?: string | null;
/**
* [Output Only] Count of VMs originally planned to be created.
*/
targetVmCount?: number | null;
}
/**
* CollectionOverride allows resource handling overrides for specific resources within a BaseType
*/
export interface Schema$CollectionOverride {
/**
* The collection that identifies this resource within its service.
*/
collection?: string | null;
/**
* Custom verb method mappings to support unordered list API mappings.
*/
methodMap?: Schema$MethodMap;
/**
* The options to apply to this resource-level override
*/
options?: Schema$Options;
}
/**
* Holds the composite type.
*/
export interface Schema$CompositeType {
/**
* An optional textual description of the resource; provided by the client when the resource is created.
*/
description?: string | null;
id?: string | null;
/**
* Output only. Creation timestamp in RFC3339 text format.
*/
insertTime?: string | null;
/**
* Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
*/
labels?: Schema$CompositeTypeLabelEntry[];
/**
* Name of the composite type, must follow the expression: `[a-z]([-a-z0-9_.]{0,61\}[a-z0-9])?`.
*/
name?: string | null;
/**
* Output only. The Operation that most recently ran, or is currently running, on this composite type.
*/
operation?: Schema$Operation;
/**
* Output only. Server defined URL for the resource.
*/
selfLink?: string | null;
status?: string | null;
/**
* Files for the template type.
*/
templateContents?: Schema$TemplateContents;
}
/**
* Label object for CompositeTypes
*/
export interface Schema$CompositeTypeLabelEntry {
/**
* Key of the label
*/
key?: string | null;
/**
* Value of the label
*/
value?: string | null;
}
/**
* A response that returns all Composite Types supported by Deployment Manager
*/
export interface Schema$CompositeTypesListResponse {
/**
* Output only. A list of resource composite types supported by Deployment Manager.
*/
compositeTypes?: Schema$CompositeType[];
/**
* A token used to continue a truncated list request.
*/
nextPageToken?: string | null;
}
export interface Schema$ConfigFile {
/**
* The contents of the file.
*/
content?: string | null;
}
/**
* The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted.
*/
export interface Schema$Credential {
/**
* Basic Auth Credential, only used by TypeProvider.
*/
basicAuth?: Schema$BasicAuth;
/**
* Service Account Credential, only used by Deployment.
*/
serviceAccount?: Schema$ServiceAccount;
/**
* Specify to use the project default credential, only supported by Deployment.
*/
useProjectDefault?: boolean | null;
}
/**
* Describes additional debugging info.
*/
export interface Schema$DebugInfo {
/**
* Additional debugging information provided by the server.
*/
detail?: string | null;
/**
* The stack trace entries indicating where the error occurred.
*/
stackEntries?: string[] | null;
}
export interface Schema$Deployment {
/**
* User provided default credential for the deployment.
*/
credential?: Schema$Credential;
/**
* An optional user-provided description of the deployment.
*/
description?: string | null;
/**
* Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.
*/
fingerprint?: string | null;
id?: string | null;
/**
* Output only. Creation timestamp in RFC3339 text format.
*/
insertTime?: string | null;
/**
* Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
*/
labels?: Schema$DeploymentLabelEntry[];
/**
* Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.
*/
manifest?: string | null;
/**
* Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
*/
name?: string | null;
/**
* Output only. The Operation that most recently ran, or is currently running, on this deployment.
*/
operation?: Schema$Operation;
/**
* Output only. List of outputs from the last manifest that deployed successfully.
*/
outputs?: Schema$DeploymentOutputEntry[];
/**
* Output only. Server defined URL for the resource.
*/
selfLink?: string | null;
/**
* [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
*/
target?: Schema$TargetConfiguration;
/**
* Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
*/
update?: Schema$DeploymentUpdate;
/**
* Output only. Update timestamp in RFC3339 text format.
*/
updateTime?: string | null;
}
/**
* Label object for Deployments
*/
export interface Schema$DeploymentLabelEntry {
/**
* Key of the label
*/
key?: string | null;
/**
* Value of the label
*/
value?: string | null;
}
/**
* Output object for Deployments
*/
export interface Schema$DeploymentOutputEntry {
/**
* Key of the output
*/
key?: string | null;
/**
* Value of the label
*/
value?: string | null;
}
export interface Schema$DeploymentsCancelPreviewRequest {
/**
* Specifies a fingerprint for `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided in `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.
*/
fingerprint?: string | null;
}
/**
* A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
*/
export interface Schema$DeploymentsListResponse {
/**
* Output only. The deployments contained in this response.
*/
deployments?: Schema$Deployment[];
/**
* Output only. A token used to continue a truncated list request.
*/
nextPageToken?: string | null;
}
export interface Schema$DeploymentsStopRequest {
/**
* Specifies a fingerprint for `stop()` requests. A fingerprint is a randomly generated value that must be provided in `stop()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.
*/
fingerprint?: string | null;
}
export interface Schema$DeploymentUpdate {
/**
* Output only. The user-provided default credential to use when deploying this preview.
*/
credential?: Schema$Credential;
/**
* Output only. An optional user-provided description of the deployment after the current update has been applied.
*/
description?: string | null;
/**
* Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
*/
labels?: Schema$DeploymentUpdateLabelEntry[];
/**
* Output only. URL of the manifest representing the update configuration of this deployment.
*/
manifest?: string | null;
}
/**
* Label object for DeploymentUpdate
*/
export interface Schema$DeploymentUpdateLabelEntry {
/**
* Key of the label
*/
key?: string | null;
/**
* Value of the label
*/
value?: string | null;
}
export interface Schema$Diagnostic {
/**
* JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
*/
field?: string | null;
/**
* Level to record this diagnostic.
*/
level?: string | null;
}
/**
* Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" \} \} This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" \} \}
*/
export interface Schema$ErrorInfo {
/**
* The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
*/
domain?: string | null;
/**
* Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"\}`, should be returned as, `{"instanceLimitPerRequest": "100"\}`, if the client exceeds the number of instances that can be created in a single (batch) request.
*/
metadatas?: {
[key: string]: string;
} | null;
/**
* The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
*/
reason?: string | null;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
export interface Schema$GlobalSetPolicyRequest {
/**
* Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.
*/
bindings?: Schema$Binding[];
/**
* Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.
*/
etag?: string | null;
/**
* REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
*/
policy?: Schema$Policy;
updateMask?: string | null;
}
/**
* Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
*/
export interface Schema$Help {
/**
* URL(s) pointing to additional information on handling the current error.
*/
links?: Schema$HelpLink[];
}
/**
* Describes a URL link.
*/
export interface Schema$HelpLink {
/**
* Describes what the link offers.
*/
description?: string | null;
/**
* The URL of the link.
*/
url?: string | null;
}
export interface Schema$ImportFile {
/**
* The contents of the file.
*/
content?: string | null;
/**
* The name of the file.
*/
name?: string | null;
}
/**
* InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
*/
export interface Schema$InputMapping {
/**
* The name of the field that is going to be injected.
*/
fieldName?: string | null;
/**
* The location where this mapping applies.
*/
location?: string | null;
/**
* Regex to evaluate on method to decide if input applies.
*/
methodMatch?: string | null;
/**
* A jsonPath expression to select an element.
*/
value?: string | null;
}
export interface Schema$InstancesBulkInsertOperationMetadata {
/**
* [Output Only] The machine type of the VMs that were created used internally only by KCP flex bulk insert.
*/
machineType?: string | null;
/**
* Status information per location (location name is key). Example key: zones/us-central1-a
*/
perLocationStatus?: {
[key: string]: Schema$BulkInsertOperationStatus;
} | null;
}
/**
* Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
*/
export interface Schema$LocalizedMessage {
/**
* The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
*/
locale?: string | null;
/**
* The localized error message in the above locale.
*/
message?: string | null;
}
export interface Schema$Manifest {
/**
* Output only. The YAML configuration for this manifest.
*/
config?: Schema$ConfigFile;
/**
* Output only. The fully-expanded configuration file, including any templates and references.
*/
expandedConfig?: string | null;
id?: string | null;
/**
* Output only. The imported files for this manifest.
*/
imports?: Schema$ImportFile[];
/**
* Output only. Creation timestamp in RFC3339 text format.
*/
insertTime?: string | null;
/**
* Output only. The YAML layout for this manifest.
*/
layout?: string | null;
/**
* Output only. The computed size of the fully expanded manifest.
*/
manifestSizeBytes?: string | null;
/**
* Output only. The size limit for expanded manifests in the project.
*/
manifestSizeLimitBytes?: string | null;
/**
* Output only. The name of the manifest.
*/
name?: string | null;
/**
* Output only. Self link for the manifest.
*/
selfLink?: string | null;
}
/**
* A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
*/
export interface Schema$ManifestsListResponse {
/**
* Output only. Manifests contained in this list response.
*/
manifests?: Schema$Manifest[];
/**
* Output only. A token used to continue a truncated list request.
*/
nextPageToken?: string | null;
}
/**
* Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy
*/
export interface Schema$MethodMap {
/**
* The action identifier for the create method to be used for this collection
*/
create?: string | null;
/**
* The action identifier for the delete method to be used for this collection
*/
delete?: string | null;
/**
* The action identifier for the get method to be used for this collection
*/
get?: string | null;
/**
* The action identifier for the setIamPolicy method to be used for this collection
*/
setIamPolicy?: string | null;
/**
* The action identifier for the update method to be used for this collection
*/
update?: string | null;
}
/**
* Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version\}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version\}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version\}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
*/
export interface Schema$Operation {
/**
* [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
*/
clientOperationId?: string | null;
/**
* [Deprecated] This field is deprecated.
*/
creationTimestamp?: string | null;
/**
* [Output Only] A textual description of the operation, which is set when the operation is created.
*/
description?: string | null;
/**
* [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
*/
endTime?: string | null;
/**
* [Output Only] If errors are generated during processing of the operation, this field will be populated.
*/
error?: {
errors?: Array<{
arguments?: string[];
code?: string;
debugInfo?: Schema$DebugInfo;
errorDetails?: Array<{
errorInfo?: Schema$ErrorInfo;
help?: Schema$Help;
localizedMessage?: Schema$LocalizedMessage;
quotaInfo?: Schema$QuotaExceededInfo;
}>;
location?: string;
message?: string;
}>;
} | null;
/**
* [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
*/
httpErrorMessage?: string | null;
/**
* [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
*/
httpErrorStatusCode?: number | null;
/**
* [Output Only] The unique identifier for the operation. This identifier is defined by the server.
*/
id?: string | null;
/**
* [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
*/
insertTime?: string | null;
instancesBulkInsertOperationMetadata?: Schema$InstancesBulkInsertOperationMetadata;
/**
* [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
*/
kind?: string | null;
/**
* [Output Only] Name of the operation.
*/
name?: string | null;
/**
* [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
*/
operationGroupId?: string | null;
/**
* [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
*/
operationType?: string | null;
/**
* [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
*/
progress?: number | null;
/**
* [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
*/
region?: string | null;
/**
* [Output Only] Server-defined URL for the resource.
*/
selfLink?: string | null;
/**
* [Output Only] Server-defined URL for this resource with the resource id.
*/
selfLinkWithId?: string | null;
/**
* This field is used internally by the Autoscaler team and should not be promoted to "alpha/beta/v1".
*/
setAutoscalerLinkOperationMetadata?: Schema$SetAutoscalerLinkOperationMetadata;
/**
* [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
*/
setCommonInstanceMetadataOperationMetadata?: Schema$SetCommonInstanceMetadataOperationMetadata;
/**
* [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
*/
startTime?: string | null;
/**
* [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
*/
status?: string | null;
/**
* [Output Only] An optional textual description of the current status of the operation.
*/
statusMessage?: string | null;
/**
* [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
*/
targetId?: string | null;
/**
* [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
*/
targetLink?: string | null;
/**
* [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
*/
user?: string | null;
/**
* [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
*/
warnings?: Array<{
code?: string;
data?: Array<{
key?: string;
value?: string;
}>;
message?: string;
}> | null;
/**
* [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
*/
zone?: string | null;
}
/**
* A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
*/
export interface Schema$OperationsListResponse {
/**
* Output only. A token used to continue a truncated list request.
*/
nextPageToken?: string | null;
/**
* Output only. Operations contained in this list response.
*/
operations?: Schema$Operation[];
}
/**
* Options allows customized resource handling by Deployment Manager.
*/
export interface Schema$Options {
/**
* Options regarding how to thread async requests.
*/
asyncOptions?: Schema$AsyncOptions[];
/**
* The mappings that apply for requests.
*/
inputMappings?: Schema$InputMapping[];
/**
* The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed.
*/
nameProperty?: string | null;
/**
* Options for how to validate and process properties on a resource.
*/
validationOptions?: Schema$ValidationOptions;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
export interface Schema$PollingOptions {
/**
* An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
*/
diagnostics?: Schema$Diagnostic[];
/**
* JsonPath expression that determines if the request failed.
*/
failCondition?: string | null;
/**
* JsonPath expression that determines if the request is completed.
*/
finishCondition?: string | null;
/**
* JsonPath expression that evaluates to string, it indicates where to poll.
*/
pollingLink?: string | null;
/**
* JsonPath expression, after polling is completed, indicates where to fetch the resource.
*/
targetLink?: string | null;
}
/**
* Additional details for quota exceeded error for resource quota.
*/
export interface Schema$QuotaExceededInfo {
/**
* The map holding related quota dimensions.
*/
dimensions?: {
[key: string]: string;
} | null;
/**
* Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
*/
futureLimit?: number | null;
/**
* Current effective quota limit. The limit's unit depends on the quota type or metric.
*/
limit?: number | null;
/**
* The name of the quota limit.
*/
limitName?: string | null;
/**
* The Compute Engine quota metric name.
*/
metricName?: string | null;
/**
* Rollout status of the future quota limit.
*/
rolloutStatus?: string | null;
}
export interface Schema$Resource {
/**
* The Access Control Policy set on this resource.
*/
accessControl?: Schema$ResourceAccessControl;
/**
* Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
*/
finalProperties?: string | null;
id?: string | null;
/**
* Output only. Creation timestamp in RFC3339 text format.
*/
insertTime?: string | null;
/**
* Output only. The last used credential that successfully created/updated the resource.
*/
lastUsedCredential?: Schema$Credential;
/**
* Output only. URL of the manifest representing the current configuration of this resource.
*/
manifest?: string | null;
/**
* Output only. The name of the resource as it appears in the YAML config.
*/
name?: string | null;
/**
* Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
*/
properties?: string | null;
/**
* Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment
*/
runtimePolicies?: string[] | null;
/**
* Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
*/
type?: string | null;
/**
* Output only. If