googleapis

/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library'; import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common'; import { GaxiosPromise } from 'gaxios'; export declare namespace deploymentmanager_v2beta { interface Options extends GlobalOptions { version: 'v2beta'; } interface StandardParameters { /** * Data format for the response. */ alt?: 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; /** * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. */ quotaUser?: string; /** * Deprecated. Please use quotaUser instead. */ userIp?: string; } /** * Google Cloud Deployment Manager API V2Beta Methods * * The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform. * * @example * const {google} = require('googleapis'); * const deploymentmanager = google.deploymentmanager('v2beta'); * * @namespace deploymentmanager * @type {Function} * @version v2beta * @variation v2beta * @param {object=} options Options for Deploymentmanager */ 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. */ interface Schema$AsyncOptions { /** * Method regex where this policy will apply. */ methodMatch?: string; /** * 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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. */ interface Schema$AuditConfig { /** * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; exemptedMembers?: string[]; /** * 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; } /** * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. */ 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[]; /** * The log type that this config enables. */ logType?: string; } /** * Authorization-related information used by Cloud Audit Logging. */ interface Schema$AuthorizationLoggingOptions { /** * The type of the permission that was checked. */ permissionType?: string; } /** * BaseType that describes a service-backed Type. */ 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; /** * Options to apply when handling any resources in this service. */ options?: Schema$Options; } /** * Basic Auth used as a credential. */ interface Schema$BasicAuth { password?: string; user?: string; } /** * Associates `members` with a `role`. */ interface Schema$Binding { /** * Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. */ condition?: Schema$Expr; /** * Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[]; /** * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */ role?: string; } /** * CollectionOverride allows resource handling overrides for specific resources within a BaseType */ interface Schema$CollectionOverride { /** * The collection that identifies this resource within its service. */ collection?: string; /** * The options to apply to this resource-level override */ options?: Schema$Options; } /** * Holds the composite type. */ interface Schema$CompositeType { /** * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; id?: string; /** * Output only. Creation timestamp in RFC3339 text format. */ insertTime?: string; /** * 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; /** * 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; status?: string; /** * Files for the template type. */ templateContents?: Schema$TemplateContents; } interface Schema$CompositeTypeLabelEntry { key?: string; value?: string; } /** * A response that returns all Composite Types supported by Deployment Manager */ 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; } /** * A condition to be met. */ interface Schema$Condition { /** * Trusted attributes supplied by the IAM system. */ iam?: string; /** * An operator to apply the subject with. */ op?: string; /** * Trusted attributes discharged by the service. */ svc?: string; /** * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. */ sys?: string; /** * DEPRECATED. Use 'values' instead. */ value?: string; /** * The objects of the condition. This is mutually exclusive with 'value'. */ values?: string[]; } interface Schema$ConfigFile { /** * The contents of the file. */ content?: string; } /** * The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. */ 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; } interface Schema$Deployment { /** * An optional user-provided description of the deployment. */ description?: string; /** * 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; id?: string; /** * Output only. Creation timestamp in RFC3339 text format. */ insertTime?: string; /** * 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$DeploymentLabelEntry[]; /** * Output only. URL of the manifest representing the last manifest that was successfully deployed. */ manifest?: string; /** * 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; /** * Output only. The Operation that most recently ran, or is currently running, on this deployment. */ operation?: Schema$Operation; /** * Output only. Server defined URL for the resource. */ selfLink?: string; /** * [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; } interface Schema$DeploymentLabelEntry { key?: string; value?: string; } 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; } /** * A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated. */ 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; } 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; } interface Schema$DeploymentUpdate { /** * Output only. An optional user-provided description of the deployment after the current update has been applied. */ description?: string; /** * Output only. 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$DeploymentUpdateLabelEntry[]; /** * Output only. URL of the manifest representing the update configuration of this deployment. */ manifest?: string; } interface Schema$DeploymentUpdateLabelEntry { key?: string; value?: string; } 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; /** * Level to record this diagnostic. */ level?: string; } /** * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" */ interface Schema$Expr { /** * An 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; /** * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. */ expression?: string; /** * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string; /** * An 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; } 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; /** * 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; } interface Schema$ImportFile { /** * The contents of the file. */ content?: string; /** * The name of the file. */ name?: string; } /** * InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API. */ interface Schema$InputMapping { /** * The name of the field that is going to be injected. */ fieldName?: string; /** * The location where this mapping applies. */ location?: string; /** * Regex to evaluate on method to decide if input applies. */ methodMatch?: string; /** * A jsonPath expression to select an element. */ value?: string; } /** * Specifies what kind of log the caller must write */ interface Schema$LogConfig { /** * Cloud audit options. */ cloudAudit?: Schema$LogConfigCloudAuditOptions; /** * Counter options. */ counter?: Schema$LogConfigCounterOptions; /** * Data access options. */ dataAccess?: Schema$LogConfigDataAccessOptions; } /** * Write a Cloud Audit log */ interface Schema$LogConfigCloudAuditOptions { /** * Information used by the Cloud Audit Logging pipeline. */ authorizationLoggingOptions?: Schema$AuthorizationLoggingOptions; /** * The log_name to populate in the Cloud Audit Record. */ logName?: string; } /** * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future). */ interface Schema$LogConfigCounterOptions { /** * The field value to attribute. */ field?: string; /** * The metric to update. */ metric?: string; } /** * Write a Data Access (Gin) log */ interface Schema$LogConfigDataAccessOptions { /** * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152). */ logMode?: string; } 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; id?: string; /** * Output only. The imported files for this manifest. */ imports?: Schema$ImportFile[]; /** * Output only. Creation timestamp in RFC3339 text format. */ insertTime?: string; /** * Output only. The YAML layout for this manifest. */ layout?: string; /** * Output only. The name of the manifest. */ name?: string; /** * Output only. Self link for the manifest. */ selfLink?: string; } /** * A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated. */ 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; } /** * An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) */ interface Schema$Operation { /** * [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. */ clientOperationId?: string; /** * [Deprecated] This field is deprecated. */ creationTimestamp?: string; /** * [Output Only] A textual description of the operation, which is set when the operation is created. */ description?: string; /** * [Output Only] The time that this operation was completed. This value is in RFC3339 text format. */ endTime?: string; /** * [Output Only] If errors are generated during processing of the operation, this field will be populated. */ error?: { errors?: Array<{ code?: string; location?: string; message?: string; }>; }; /** * [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. */ httpErrorMessage?: string; /** * [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; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string; /** * [Output Only] The time that this operation was requested. This value is in RFC3339 text format. */ insertTime?: string; /** * [Output Only] Type of the resource. Always compute#operation for Operation resources. */ kind?: string; /** * [Output Only] Name of the resource. */ name?: string; /** * [Output Only] The type of operation, such as insert, update, or delete, and so on. */ operationType?: string; /** * [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; /** * [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ region?: string; /** * [Output Only] Server-defined URL for the resource. */ selfLink?: string; /** * [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. */ startTime?: string; /** * [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. */ status?: string; /** * [Output Only] An optional textual description of the current status of the operation. */ statusMessage?: string; /** * [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. */ targetId?: string; /** * [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. */ targetLink?: string; /** * [Output Only] User who requested the operation, for example: user@example.com. */ user?: string; /** * [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; }>; /** * [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ zone?: string; } /** * A response containing a partial list of operations and a page token used to build the next request if the request has been truncated. */ interface Schema$OperationsListResponse { /** * Output only. A token used to continue a truncated list request. */ nextPageToken?: string; /** * Output only. Operations contained in this list response. */ operations?: Schema$Operation[]; } /** * Options allows customized resource handling by Deployment Manager. */ interface Schema$Options { /** * Options regarding how to thread async requests. */ asyncOptions?: Schema$AsyncOptions[]; /** * The mappings that apply for requests. */ inputMappings?: Schema$InputMapping[]; /** * Options for how to validate and process properties on a resource. */ validationOptions?: Schema$ValidationOptions; /** * Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number */ virtualProperties?: string; } /** * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). */ interface Schema$Policy { /** * Specifies cloud audit logging configuration for this policy. */ auditConfigs?: Schema$AuditConfig[]; /** * Associates a list of `members` to a `role`. `bindings` with no members will result in an error. */ 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. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. */ etag?: string; iamOwned?: boolean; /** * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. */ rules?: Schema$Rule[]; /** * Deprecated. */ version?: number; } 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; /** * JsonPath expression that determines if the request is completed. */ finishCondition?: string; /** * JsonPath expression that evaluates to string, it indicates where to poll. */ pollingLink?: string; /** * JsonPath expression, after polling is completed, indicates where to fetch the resource. */ targetLink?: string; } 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; id?: string; /** * Output only. Creation timestamp in RFC3339 text format. */ insertTime?: string; /** * Output only. URL of the manifest representing the current configuration of this resource. */ manifest?: string; /** * Output only. The name of the resource as it appears in the YAML config. */ name?: string; /** * Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. */ properties?: string; /** * Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function. */ type?: string; /** * Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here. */ update?: Schema$ResourceUpdate; /** * Output only. Update timestamp in RFC3339 text format. */ updateTime?: string; /** * Output only. The URL of the actual resource. */ url?: string; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; data?: Array<{ key?: string; value?: string; }>; message?: string; }>; } /** * The access controls set on the resource. */ interface Schema$ResourceAccessControl { /** * The GCP IAM Policy to set on the resource. */ gcpIamPolicy?: string; } /** * A response containing a partial list of resources and a page token used to build the next request if the request has been truncated. */ interface Schema$ResourcesListResponse { /** * A token used to continue a truncated list request. */ nextPageToken?: string; /** * Resources contained in this list response. */ resources?: Schema$Resource[]; } interface Schema$ResourceUpdate { /** * The Access Control Policy to set on this resource after updating the resource itself. */ accessControl?: Schema$ResourceAccessControl; /** * Output only. If errors are generated during update of the resource, this field will be populated. */ error?: { errors?: Array<{ code?: string; location?: string; message?: string; }>; }; /** * Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML. */ finalProperties?: string; /** * Output only. The intent of the resource: PREVIEW, UPDATE, or CANCEL. */ intent?: string; /** * Output only. URL of the manifest representing the update configuration of this resource. */ manifest?: string; /** * Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML. */ properties?: string; /** * Output only. The state of the resource. */ state?: string; /** * Output only. If warning messages are generated during processing of this resource, this field will be populated. */ warnings?: Array<{ code?: string; data?: Array<{ key?: string; value?: string; }>; message?: string; }>; } /** * A rule to be applied in a Policy. */ interface Schema$Rule { /** * Required */ action?: string; /** * Additional restrictions that must be met. All conditions must pass for the rule to match. */ conditions?: Schema$Condition[]; /** * Human-readable description of the rule. */ description?: string; /** * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. */ ins?: string[]; /** * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. */ logConfigs?: Schema$LogConfig[]; /** * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. */ notIns?: string[]; /** * A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. */ permissions?: string[]; } /** * Service Account used as a credential. */ interface Schema$ServiceAccount { /** * The IAM service account email address like test@myproject.iam.gserviceaccount.com */ email?: string; } interface Schema$TargetConfiguration { /** * The configuration to use for this deployment. */ config?: Schema$ConfigFile; /** * Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. */ imports?: Schema$ImportFile[]; } /** * Files that make up the template contents of a template type. */ interface Schema$TemplateContents { /** * Import files referenced by the main template. */ imports?: Schema$ImportFile[]; /** * Which interpreter (python or jinja) should be used during expansion. */ interpreter?: string; /** * The filename of the mainTemplate */ mainTemplate?: string; /** * The contents of the template schema. */ schema?: string; /** * The contents of the main template file. */ template?: string; } interface Schema$TestPermissionsRequest { /** * The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. */ permissions?: string[]; } interface Schema$TestPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */ permissions?: string[]; } /** * A resource type supported by Deployment Manager. */ interface Schema$Type { /** * Base Type (configurable service) that backs this Type. */ base?: Schema$BaseType; /** * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; id?: string; /** * Output only. Creation timestamp in RFC3339 text format. */ insertTime?: string; /** * 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$TypeLabelEntry[]; /** * Name of the type. */ name?: string; /** * Output only. The Operation that most recently ran, or is currently running, on this type. */ operation?: Schema$Operation; /** * Output only. Server defined URL for the resource. */ selfLink?: string; } /** * Type Information. Contains detailed information about a composite type, base type, or base type with specific collection. */ interface Schema$TypeInfo { /** * The description of the type. */ description?: string; /** * For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty. */ documentationLink?: string; /** * Output only. Type of the output. Always deploymentManager#TypeInfo for TypeInfo. */ kind?: string; /** * The base type or composite type name. */ name?: string; /** * For base types with a collection, we return a schema and documentation link For template types, we return only a schema */ schema?: Schema$TypeInfoSchemaInfo; /** * Output only. Self link for the type provider. */ selfLink?: string; /** * The title on the API descriptor URL provided. */ title?: string; } interface Schema$TypeInfoSchemaInfo { /** * The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4 */ input?: string; /** * The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4 */ output?: string; } interface Schema$TypeLabelEntry { key?: string; value?: string; } /** * A type provider that describes a service-backed Type. */ interface Schema$TypeProvider { /** * Allows resource handling overrides for specific collections */ collectionOverrides?: Schema$CollectionOverride[]; /** * Credential used when interacting with this type. */ credential?: Schema$Credential; /** * An optional textual description of the resource; provided by the client when the resource is created. */ description?: string; /** * Descriptor Url for the this type provider. */ descriptorUrl?: string; /** * Output only. Unique identifier for the resource defined by the server. */ id?: string; /** * Output only. Creation timestamp in RFC3339 text format. */ insertTime?: string; /** * 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$TypeProviderLabelEntry[]; /** * 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; /** * Output only. The Operation that most recently ran, or is currently running, on this type provider. */ operation?: Schema$Operation; /** * Options to apply when handling any resources in this service. */ options?: Schema$Options; /** * Output only. Self link for the type provider. */ selfLink?: string; } interface Schema$TypeProviderLabelEntry { key?: string; value?: string; } /** * A response that returns all Type Providers supported by Deployment Manager */ interface Schema$TypeProvidersListResponse { /** * A token used to continue a truncated list request. */ nextPageToken?: string; /** * Output only. A list of resource type providers supported by Deployment Manager. */ typeProviders?: Schema$TypeProvider[]; } interface Schema$TypeProvidersListTypesResponse { /** * A token used to continue a truncated list request. */ nextPageToken?: string; /** * Output only. A list of resource type info. */ types?: Schema$TypeInfo[]; } /** * A response that returns all Types supported by Deployment Manager */ interface Schema$TypesListResponse { /** * A token used to continue a truncated list request. */ nextPageToken?: string; /** * Output only. A list of resource types supported by Deployment Manager. */ types?: Schema$Type[]; } /** * Options for how to validate and process properties on a resource. */ interface Schema$ValidationOptions { /** * Customize how deployment manager will validate the resource against schema errors. */ schemaValidation?: string; /** * Specify what to do with extra properties when executing a request. */ undeclaredProperties?: string; } class Resource$Compositetypes { context: APIRequestContext; constructor(context: APIRequestContext); /** * deploymentmanager.compositeTypes.delete * @desc Deletes a composite type. * @alias deploymentmanager.compositeTypes.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.compositeType The name of the type for this request. * @param {string} params.project The project ID for this request. * @param {object} [options] Optionally override request options, such as