UNPKG

googleapis

Version:
1,482 lines (1,481 loc) 71.9 kB
/** * Copyright 2015 Google Inc. All Rights Reserved. * * 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 { AxiosPromise } from 'axios'; import { GoogleApis } from '../..'; import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api'; /** * App Engine Admin API * * The App Engine Admin API enables developers to provision and manage their App * Engine applications. * * @example * const google = require('googleapis'); * const appengine = google.appengine('v1beta4'); * * @namespace appengine * @type {Function} * @version v1beta4 * @variation v1beta4 * @param {object=} options Options for Appengine */ export declare class Appengine { _options: GlobalOptions; google: GoogleApis; root: this; apps: Resource$Apps; constructor(options: GlobalOptions, google: GoogleApis); getRoot(): this; } /** * Google Cloud Endpoints * (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for * API handlers. */ export interface Schema$ApiConfigHandler { /** * Action to take when users access resources that require authentication. * Defaults to redirect. */ authFailAction: string; /** * Level of login required to access this resource. Defaults to optional. */ login: string; /** * Path to the script from the application root directory. */ script: string; /** * Security (HTTPS) enforcement for this URL. */ securityLevel: string; /** * URL to serve the endpoint at. */ url: string; } /** * Uses Google Cloud Endpoints to handle requests. */ export interface Schema$ApiEndpointHandler { /** * Path to the script from the application root directory. */ scriptPath: string; } /** * An Application resource contains the top-level configuration of an App Engine * application. */ export interface Schema$Application { /** * Google Apps authentication domain that controls which users can access this * application.Defaults to open access for any Google Account. */ authDomain: string; /** * Google Cloud Storage bucket that can be used for storing files associated * with this application. This bucket is associated with the application and * can be used by the gcloud deployment commands.@OutputOnly */ codeBucket: string; /** * Google Cloud Storage bucket that can be used by this application to store * content.@OutputOnly */ defaultBucket: string; /** * Cookie expiration policy for this application. */ defaultCookieExpiration: string; /** * Hostname used to reach the application, as resolved by App * Engine.@OutputOnly */ defaultHostname: string; /** * HTTP path dispatch rules for requests to the application that do not * explicitly target a module or version. Rules are * order-dependent.@OutputOnly */ dispatchRules: Schema$UrlDispatchRule[]; iap: Schema$IdentityAwareProxy; /** * Identifier of the Application resource. This identifier is equivalent to * the project ID of the Google Cloud Platform project where you want to * deploy your application. Example: myapp. */ id: string; /** * Location from which this application will be run. Application instances * will run out of data centers in the chosen location, which is also where * all of the application&#39;s end user content is stored.Defaults to * us-central.Options are:us-central - Central USeurope-west - Western * Europeus-east1 - Eastern US */ location: string; /** * Full path to the Application resource in the API. Example: * apps/myapp.@OutputOnly */ name: string; } /** * Automatic scaling is based on request rate, response latencies, and other * application metrics. */ export interface Schema$AutomaticScaling { /** * Amount of time that the Autoscaler * (https://cloud.google.com/compute/docs/autoscaler/) should wait between * changes to the number of virtual machines. Only applicable for VM runtimes. */ coolDownPeriod: string; /** * Target scaling by CPU usage. */ cpuUtilization: Schema$CpuUtilization; /** * Target scaling by disk usage. */ diskUtilization: Schema$DiskUtilization; /** * Number of concurrent requests an automatic scaling instance can accept * before the scheduler spawns a new instance.Defaults to a runtime-specific * value. */ maxConcurrentRequests: number; /** * Maximum number of idle instances that should be maintained for this * version. */ maxIdleInstances: number; /** * Maximum amount of time that a request should wait in the pending queue * before starting a new instance to handle it. */ maxPendingLatency: string; /** * Maximum number of instances that should be started to handle requests. */ maxTotalInstances: number; /** * Minimum number of idle instances that should be maintained for this * version. Only applicable for the default version of a module. */ minIdleInstances: number; /** * Minimum amount of time a request should wait in the pending queue before * starting a new instance to handle it. */ minPendingLatency: string; /** * Minimum number of instances that should be maintained for this version. */ minTotalInstances: number; /** * Target scaling by network usage. */ networkUtilization: Schema$NetworkUtilization; /** * Target scaling by request utilization. */ requestUtilization: Schema$RequestUtilization; } /** * A module with basic scaling will create an instance when the application * receives a request. The instance will be turned down when the app becomes * idle. Basic scaling is ideal for work that is intermittent or driven by user * activity. */ export interface Schema$BasicScaling { /** * Duration of time after the last request that an instance must wait before * the instance is shut down. */ idleTimeout: string; /** * Maximum number of instances to create for this version. */ maxInstances: number; } /** * Docker image that is used to create a container and start a VM instance for * the version that you deploy. Only applicable for instances running in the App * Engine flexible environment. */ export interface Schema$ContainerInfo { /** * URI to the hosted container image in Google Container Registry. The URI * must be fully qualified and include a tag or digest. Examples: * &quot;gcr.io/my-project/image:tag&quot; or * &quot;gcr.io/my-project/image@digest&quot; */ image: string; } /** * Target scaling by CPU usage. */ export interface Schema$CpuUtilization { /** * Period of time over which CPU utilization is calculated. */ aggregationWindowLength: string; /** * Target CPU utilization ratio to maintain when scaling. Must be between 0 * and 1. */ targetUtilization: number; } /** * Metadata for the given google.longrunning.Operation during a * google.appengine.v1.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1 { /** * The Cloud Build ID if one was created as part of the version create. * @OutputOnly */ cloudBuildId: string; } /** * Metadata for the given google.longrunning.Operation during a * google.appengine.v1alpha.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Alpha { /** * The Cloud Build ID if one was created as part of the version create. * @OutputOnly */ cloudBuildId: string; } /** * Metadata for the given google.longrunning.Operation during a * google.appengine.v1beta.CreateVersionRequest. */ export interface Schema$CreateVersionMetadataV1Beta { /** * The Cloud Build ID if one was created as part of the version create. * @OutputOnly */ cloudBuildId: string; } /** * Request message for Instances.DebugInstance. */ export interface Schema$DebugInstanceRequest { /** * Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa * [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh * {&quot;userName&quot;:&quot;[USERNAME]&quot;,&quot;expireOn&quot;:&quot;[EXPIRE_TIME]&quot;}For * more information, see Adding and Removing SSH Keys * (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys). */ sshKey: string; } /** * Code and application artifacts used to deploy a version to App Engine. */ export interface Schema$Deployment { /** * The Docker image for the container that runs the version. Only applicable * for instances running in the App Engine flexible environment. */ container: Schema$ContainerInfo; /** * Manifest of the files stored in Google Cloud Storage that are included as * part of this version. All files must be readable using the credentials * supplied with this call. */ files: any; /** * Origin of the source code for this deployment. There can be more than one * source reference per version if source code is distributed among multiple * repositories. */ sourceReferences: Schema$SourceReference[]; } /** * Target scaling by disk usage. Only applicable for VM runtimes. */ export interface Schema$DiskUtilization { /** * Target bytes read per second. */ targetReadBytesPerSec: number; /** * Target ops read per second. */ targetReadOpsPerSec: number; /** * Target bytes written per second. */ targetWriteBytesPerSec: number; /** * Target ops written per second. */ targetWriteOpsPerSec: number; } /** * Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The * Endpoints API Service provides tooling for serving Open API and gRPC * endpoints via an NGINX proxy. Only valid for App Engine Flexible environment * deployments..The fields here refer to the name and configuration id of a * &quot;service&quot; resource in the Service Management API * (https://cloud.google.com/service-management/overview). */ export interface Schema$EndpointsApiService { /** * Endpoints service configuration id as specified by the Service Management * API. For example &quot;2016-09-19r1&quot;By default, the Endpoints service * configuration id is fixed and config_id must be specified. To keep the * Endpoints service configuration id updated with each rollout, specify * RolloutStrategy.MANAGED and omit config_id. */ configId: string; /** * Endpoints service name which is the name of the &quot;service&quot; * resource in the Service Management API. For example * &quot;myapi.endpoints.myproject.cloud.goog&quot; */ name: string; /** * Endpoints rollout strategy. If FIXED, config_id must be specified. If * MANAGED, config_id must be omitted. */ rolloutStrategy: string; } /** * Custom static error page to be served when an error occurs. */ export interface Schema$ErrorHandler { /** * Error condition this handler applies to. */ errorCode: string; /** * MIME type of file. Defaults to text/html. */ mimeType: string; /** * Static file content to be served for this error. */ staticFile: string; } /** * Single source file that is part of the version to be deployed. Each source * file that is deployed must be specified separately. */ export interface Schema$FileInfo { /** * The MIME type of the file.Defaults to the value from Google Cloud Storage. */ mimeType: string; /** * The SHA1 hash of the file, in hex. */ sha1Sum: string; /** * URL source to use to fetch this file. Must be a URL to a resource in Google * Cloud Storage in the form * &#39;http(s)://storage.googleapis.com/&lt;bucket&gt;/&lt;object&gt;&#39;. */ sourceUrl: string; } /** * Health checking configuration for VM instances. Unhealthy instances are * killed and replaced with new instances. Only applicable for instances in App * Engine flexible environment. */ export interface Schema$HealthCheck { /** * Interval between health checks. */ checkInterval: string; /** * Whether to explicitly disable health checks for this instance. */ disableHealthCheck: boolean; /** * Number of consecutive successful health checks required before receiving * traffic. */ healthyThreshold: number; /** * Host header to send when performing an HTTP health check. Example: * &quot;myapp.appspot.com&quot; */ host: string; /** * Number of consecutive failed health checks required before an instance is * restarted. */ restartThreshold: number; /** * Time before the health check is considered failed. */ timeout: string; /** * Number of consecutive failed health checks required before removing * traffic. */ unhealthyThreshold: number; } /** * Identity-Aware Proxy */ export interface Schema$IdentityAwareProxy { /** * Whether the serving infrastructure will authenticate and authorize all * incoming requests.If true, the oauth2_client_id and oauth2_client_secret * fields must be non-empty. */ enabled: boolean; /** * OAuth2 client ID to use for the authentication flow. */ oauth2ClientId: string; /** * For security reasons, this value cannot be retrieved via the API. Instead, * the SHA-256 hash of the value is returned in the * oauth2_client_secret_sha256 field.@InputOnly */ oauth2ClientSecret: string; /** * Hex-encoded SHA-256 hash of the client secret.@OutputOnly */ oauth2ClientSecretSha256: string; } /** * An Instance resource is the computing unit that App Engine uses to * automatically scale an application. */ export interface Schema$Instance { /** * App Engine release this instance is running on.@OutputOnly */ appEngineRelease: string; /** * Availability of the instance.@OutputOnly */ availability: string; /** * Average latency (ms) over the last minute.@OutputOnly */ averageLatency: number; /** * Number of errors since this instance was started.@OutputOnly */ errors: number; /** * Relative name of the instance within the version. Example: * instance-1.@OutputOnly */ id: string; /** * Total memory in use (bytes).@OutputOnly */ memoryUsage: string; /** * Full path to the Instance resource in the API. Example: * apps/myapp/modules/default/versions/v1/instances/instance-1.@OutputOnly */ name: string; /** * Average queries per second (QPS) over the last minute.@OutputOnly */ qps: number; /** * Number of requests since this instance was started.@OutputOnly */ requests: number; /** * Time that this instance was started.@OutputOnly */ startTimestamp: string; /** * Virtual machine ID of this instance. Only applicable for instances in App * Engine flexible environment.@OutputOnly */ vmId: string; /** * The IP address of this instance. Only applicable for instances in App * Engine flexible environment.@OutputOnly */ vmIp: string; /** * Name of the virtual machine where this instance lives. Only applicable for * instances in App Engine flexible environment.@OutputOnly */ vmName: string; /** * Status of the virtual machine where this instance lives. Only applicable * for instances in App Engine flexible environment.@OutputOnly */ vmStatus: string; /** * Whether this instance is in debug mode. Only applicable for instances in * App Engine flexible environment.@OutputOnly */ vmUnlocked: boolean; /** * Zone where the virtual machine is located. Only applicable for instances in * App Engine flexible environment.@OutputOnly */ vmZoneName: string; } /** * Third-party Python runtime library that is required by the application. */ export interface Schema$Library { /** * Name of the library. Example: &quot;django&quot;. */ name: string; /** * Version of the library to select, or &quot;latest&quot;. */ version: string; } /** * Response message for Instances.ListInstances. */ export interface Schema$ListInstancesResponse { /** * The instances belonging to the requested version. */ instances: Schema$Instance[]; /** * Continuation token for fetching the next page of results. */ nextPageToken: string; } /** * The response message for Locations.ListLocations. */ export interface Schema$ListLocationsResponse { /** * A list of locations that matches the specified filter in the request. */ locations: Schema$Location[]; /** * The standard List next-page token. */ nextPageToken: string; } /** * Response message for Modules.ListModules. */ export interface Schema$ListModulesResponse { /** * The modules belonging to the requested application. */ modules: Schema$Module[]; /** * Continuation token for fetching the next page of results. */ nextPageToken: string; } /** * The response message for Operations.ListOperations. */ export interface Schema$ListOperationsResponse { /** * The standard List next-page token. */ nextPageToken: string; /** * A list of operations that matches the specified filter in the request. */ operations: Schema$Operation[]; } /** * Response message for Versions.ListVersions. */ export interface Schema$ListVersionsResponse { /** * Continuation token for fetching the next page of results. */ nextPageToken: string; /** * The versions belonging to the requested module. */ versions: Schema$Version[]; } /** * A resource that represents Google Cloud Platform location. */ export interface Schema$Location { /** * The friendly name for this location, typically a nearby city name. For * example, &quot;Tokyo&quot;. */ displayName: string; /** * Cross-service attributes for the location. For example * {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;} */ labels: any; /** * The canonical id for this location. For example: &quot;us-east1&quot;. */ locationId: string; /** * Service-specific metadata. For example the available capacity at the given * location. */ metadata: any; /** * Resource name for the location, which may vary between implementations. For * example: &quot;projects/example-project/locations/us-east1&quot; */ name: string; } /** * Metadata for the given google.cloud.location.Location. */ export interface Schema$LocationMetadata { /** * App Engine flexible environment is available in the given * location.@OutputOnly */ flexibleEnvironmentAvailable: boolean; /** * App Engine standard environment is available in the given * location.@OutputOnly */ standardEnvironmentAvailable: boolean; } /** * A module with manual scaling runs continuously, allowing you to perform * complex initialization and rely on the state of its memory over time. */ export interface Schema$ManualScaling { /** * Number of instances to assign to the module at the start. This number can * later be altered by using the Modules API * (https://cloud.google.com/appengine/docs/python/modules/functions) * set_num_instances() function. */ instances: number; } /** * A Module resource is a logical component of an application that can share * state and communicate in a secure fashion with other modules. For example, an * application that handles customer requests might include separate modules to * handle tasks such as backend data analysis or API requests from mobile * devices. Each module has a collection of versions that define a specific set * of code used to implement the functionality of that module. */ export interface Schema$Module { /** * Relative name of the module within the application. Example: * default.@OutputOnly */ id: string; /** * Full path to the Module resource in the API. Example: * apps/myapp/modules/default.@OutputOnly */ name: string; /** * Mapping that defines fractional HTTP traffic diversion to different * versions within the module. */ split: Schema$TrafficSplit; } /** * Extra network settings. Only applicable for VM runtimes. */ export interface Schema$Network { /** * List of ports, or port pairs, to forward from the virtual machine to the * application container. */ forwardedPorts: string[]; /** * Tag to apply to the VM instance during creation. */ instanceTag: string; /** * Google Cloud Platform network where the virtual machines are created. * Specify the short name, not the resource path.Defaults to default. */ name: string; } /** * Target scaling by network usage. Only applicable for VM runtimes. */ export interface Schema$NetworkUtilization { /** * Target bytes received per second. */ targetReceivedBytesPerSec: number; /** * Target packets received per second. */ targetReceivedPacketsPerSec: number; /** * Target bytes sent per second. */ targetSentBytesPerSec: number; /** * Target packets sent per second. */ targetSentPacketsPerSec: number; } /** * This resource represents a long-running operation that is the result of a * network API call. */ export interface Schema$Operation { /** * If the value is false, it means the operation is still in progress. If * true, the operation is completed, and either error or response is * available. */ done: boolean; /** * The error result of the operation in case of failure or cancellation. */ error: Schema$Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. Some * services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata: any; /** * The server-assigned name, which is only unique within the same service that * originally returns it. If you use the default HTTP mapping, the name should * have the format of operations/some/unique/name. */ name: string; /** * The normal response of the operation in case of success. If the original * method returns no data on success, such as Delete, the response is * google.protobuf.Empty. If the original method is standard * Get/Create/Update, the response should be the resource. For other methods, * the response should have the type XxxResponse, where Xxx is the original * method name. For example, if the original method name is TakeSnapshot(), * the inferred response type is TakeSnapshotResponse. */ response: any; } /** * Metadata for the given google.longrunning.Operation. */ export interface Schema$OperationMetadata { /** * Timestamp that this operation completed.@OutputOnly */ endTime: string; /** * Timestamp that this operation was created.@OutputOnly */ insertTime: string; /** * API method that initiated this operation. Example: * google.appengine.v1beta4.Version.CreateVersion.@OutputOnly */ method: string; /** * Type of this operation. Deprecated, use method field instead. Example: * &quot;create_version&quot;.@OutputOnly */ operationType: string; /** * Name of the resource that this operation is acting on. Example: * apps/myapp/modules/default.@OutputOnly */ target: string; /** * User who requested this operation.@OutputOnly */ user: string; } /** * Metadata for the given google.longrunning.Operation. */ export interface Schema$OperationMetadataV1 { createVersionMetadata: Schema$CreateVersionMetadataV1; /** * Time that this operation completed.@OutputOnly */ endTime: string; /** * Ephemeral message that may change every time the operation is polled. * @OutputOnly */ ephemeralMessage: string; /** * Time that this operation was created.@OutputOnly */ insertTime: string; /** * API method that initiated this operation. Example: * google.appengine.v1.Versions.CreateVersion.@OutputOnly */ method: string; /** * Name of the resource that this operation is acting on. Example: * apps/myapp/services/default.@OutputOnly */ target: string; /** * User who requested this operation.@OutputOnly */ user: string; /** * Durable messages that persist on every operation poll. @OutputOnly */ warning: string[]; } /** * Metadata for the given google.longrunning.Operation. */ export interface Schema$OperationMetadataV1Alpha { createVersionMetadata: Schema$CreateVersionMetadataV1Alpha; /** * Time that this operation completed.@OutputOnly */ endTime: string; /** * Ephemeral message that may change every time the operation is polled. * @OutputOnly */ ephemeralMessage: string; /** * Time that this operation was created.@OutputOnly */ insertTime: string; /** * API method that initiated this operation. Example: * google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly */ method: string; /** * Name of the resource that this operation is acting on. Example: * apps/myapp/services/default.@OutputOnly */ target: string; /** * User who requested this operation.@OutputOnly */ user: string; /** * Durable messages that persist on every operation poll. @OutputOnly */ warning: string[]; } /** * Metadata for the given google.longrunning.Operation. */ export interface Schema$OperationMetadataV1Beta { createVersionMetadata: Schema$CreateVersionMetadataV1Beta; /** * Time that this operation completed.@OutputOnly */ endTime: string; /** * Ephemeral message that may change every time the operation is polled. * @OutputOnly */ ephemeralMessage: string; /** * Time that this operation was created.@OutputOnly */ insertTime: string; /** * API method that initiated this operation. Example: * google.appengine.v1beta.Versions.CreateVersion.@OutputOnly */ method: string; /** * Name of the resource that this operation is acting on. Example: * apps/myapp/services/default.@OutputOnly */ target: string; /** * User who requested this operation.@OutputOnly */ user: string; /** * Durable messages that persist on every operation poll. @OutputOnly */ warning: string[]; } /** * Metadata for the given google.longrunning.Operation. */ export interface Schema$OperationMetadataV1Beta5 { /** * Timestamp that this operation completed.@OutputOnly */ endTime: string; /** * Timestamp that this operation was created.@OutputOnly */ insertTime: string; /** * API method name that initiated this operation. Example: * google.appengine.v1beta5.Version.CreateVersion.@OutputOnly */ method: string; /** * Name of the resource that this operation is acting on. Example: * apps/myapp/services/default.@OutputOnly */ target: string; /** * User who requested this operation.@OutputOnly */ user: string; } /** * Target scaling by request utilization. Only applicable for VM runtimes. */ export interface Schema$RequestUtilization { /** * Target number of concurrent requests. */ targetConcurrentRequests: number; /** * Target requests per second. */ targetRequestCountPerSec: number; } /** * Machine resources for a version. */ export interface Schema$Resources { /** * Number of CPU cores needed. */ cpu: number; /** * Disk size (GB) needed. */ diskGb: number; /** * Memory (GB) needed. */ memoryGb: number; /** * User specified volumes. */ volumes: Schema$Volume[]; } /** * Executes a script to handle the request that matches the URL pattern. */ export interface Schema$ScriptHandler { /** * Path to the script from the application root directory. */ scriptPath: string; } /** * Reference to a particular snapshot of the source tree used to build and * deploy the application. */ export interface Schema$SourceReference { /** * URI string identifying the repository. Example: * &quot;https://source.developers.google.com/p/app-123/r/default&quot; */ repository: string; /** * The canonical, persistent identifier of the deployed revision. Aliases that * include tags or branch names are not allowed. Example (git): * &quot;2198322f89e0bb2e25021667c2ed489d1fd34e6b&quot; */ revisionId: string; } /** * Files served directly to the user for a given URL, such as images, CSS * stylesheets, or JavaScript source files. Static directory handlers make it * easy to serve the entire contents of a directory as static files. */ export interface Schema$StaticDirectoryHandler { /** * Whether files should also be uploaded as code data. By default, files * declared in static directory handlers are uploaded as static data and are * only served to end users; they cannot be read by the application. If * enabled, uploads are charged against both your code and static data storage * resource quotas. */ applicationReadable: boolean; /** * Path to the directory containing the static files from the application root * directory. Everything after the end of the matched URL pattern is appended * to static_dir to form the full path to the requested file. */ directory: string; /** * Time a static file served by this handler should be cached. */ expiration: string; /** * HTTP headers to use for all responses from these URLs. */ httpHeaders: any; /** * MIME type used to serve all files served by this handler. Defaults to * file-specific MIME types, which are direved from each file&#39;s filename * extension. */ mimeType: string; /** * Whether this handler should match the request if the file referenced by the * handler does not exist. */ requireMatchingFile: boolean; } /** * Files served directly to the user for a given URL, such as images, CSS * stylesheets, or JavaScript source files. Static file handlers describe which * files in the application directory are static files, and which URLs serve * them. */ export interface Schema$StaticFilesHandler { /** * Whether files should also be uploaded as code data. By default, files * declared in static file handlers are uploaded as static data and are only * served to end users; they cannot be read by the application. If enabled, * uploads are charged against both your code and static data storage resource * quotas. */ applicationReadable: boolean; /** * Time a static file served by this handler should be cached. */ expiration: string; /** * HTTP headers to use for all responses from these URLs. */ httpHeaders: any; /** * MIME type used to serve all files served by this handler. Defaults to * file-specific MIME types, which are derived from each file&#39;s filename * extension. */ mimeType: string; /** * Path to the static files matched by the URL pattern, from the application * root directory. The path can refer to text matched in groupings in the URL * pattern. */ path: string; /** * Whether this handler should match the request if the file referenced by the * handler does not exist. */ requireMatchingFile: boolean; /** * Regular expression that matches the file paths for all files that should be * referenced by this handler. */ uploadPathRegex: string; } /** * 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). The error model is designed to be: Simple to * use and understand for most users Flexible enough to meet unexpected * needsOverviewThe Status message contains three pieces of data: error code, * error message, and error details. The error code should be an enum value of * google.rpc.Code, but it may accept additional error codes if needed. The * error message should be a developer-facing English message that helps * developers understand and resolve the error. If a localized user-facing error * message is needed, put the localized message in the error details or localize * it in the client. The optional error details may contain arbitrary * information about the error. There is a predefined set of error detail types * in the package google.rpc that can be used for common error * conditions.Language mappingThe Status message is the logical representation * of the error model, but it is not necessarily the actual wire format. When * the Status message is exposed in different client libraries and different * wire protocols, it can be mapped differently. For example, it will likely be * mapped to some exceptions in Java, but more likely mapped to some error codes * in C.Other usesThe error model and the Status message can be used in a * variety of environments, either with or without APIs, to provide a consistent * developer experience across different environments.Example uses of this error * model include: Partial errors. If a service needs to return partial errors to * the client, it may embed the Status in the normal response to indicate the * partial errors. Workflow errors. A typical workflow has multiple steps. Each * step may have a Status message for error reporting. Batch operations. If a * client uses batch request and batch response, the Status message should be * used directly inside batch response, one for each error sub-response. * Asynchronous operations. If an API call embeds asynchronous operation results * in its response, the status of those operations should be represented * directly using the Status message. Logging. If some API errors are stored in * logs, the message Status could be used directly after any stripping needed * for security/privacy reasons. */ export interface Schema$Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code: number; /** * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ details: any[]; /** * 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; } /** * Traffic routing configuration for versions within a single module. Traffic * splits define how traffic directed to the module is assigned to versions. */ export interface Schema$TrafficSplit { /** * Mapping from version IDs within the module to fractional (0.000, 1] * allocations of traffic for that version. Each version can be specified only * once, but some versions in the module may not have any traffic allocation. * Modules that have traffic allocated cannot be deleted until either the * module is deleted or their traffic allocation is removed. Allocations must * sum to 1. Up to two decimal place precision is supported for IP-based * splits and up to three decimal places is supported for cookie-based splits. */ allocations: any; /** * Mechanism used to determine which version a request is sent to. The traffic * selection algorithm will be stable for either type until allocations are * changed. */ shardBy: string; } /** * Rules to match an HTTP request and dispatch that request to a module. */ export interface Schema$UrlDispatchRule { /** * Domain name to match against. The wildcard &quot;*&quot; is supported if * specified before a period: &quot;*.&quot;.Defaults to matching all domains: * &quot;*&quot;. */ domain: string; /** * Resource ID of a module in this application that should serve the matched * request. The module must already exist. Example: default. */ module: string; /** * Pathname within the host. Must start with a &quot;/&quot;. A single * &quot;*&quot; can be included at the end of the path. The sum of the * lengths of the domain and path may not exceed 100 characters. */ path: string; } /** * URL pattern and description of how the URL should be handled. App Engine can * handle URLs by executing application code, or by serving static files * uploaded with the version, such as images, CSS, or JavaScript. */ export interface Schema$UrlMap { /** * Uses API Endpoints to handle requests. */ apiEndpoint: Schema$ApiEndpointHandler; /** * Action to take when users access resources that require authentication. * Defaults to redirect. */ authFailAction: string; /** * Level of login required to access this resource. */ login: string; /** * 30x code to use when performing redirects for the secure field. Defaults to * 302. */ redirectHttpResponseCode: string; /** * Executes a script to handle the request that matches this URL pattern. */ script: Schema$ScriptHandler; /** * Security (HTTPS) enforcement for this URL. */ securityLevel: string; /** * Serves the entire contents of a directory as static files.This attribute is * deprecated. You can mimic the behavior of static directories using static * files. */ staticDirectory: Schema$StaticDirectoryHandler; /** * Returns the contents of a file, such as an image, as the response. */ staticFiles: Schema$StaticFilesHandler; /** * A URL prefix. Uses regular expression syntax, which means regexp special * characters must be escaped, but should not contain groupings. All URLs that * begin with this prefix are handled by this handler, using the portion of * the URL after the prefix as part of the file path. */ urlRegex: string; } /** * A Version resource is a specific set of source code and configuration files * that are deployed into a module. */ export interface Schema$Version { /** * Serving configuration for Google Cloud Endpoints * (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned * in GET requests if view=FULL is set. */ apiConfig: Schema$ApiConfigHandler; /** * Automatic scaling is based on request rate, response latencies, and other * application metrics. */ automaticScaling: Schema$AutomaticScaling; /** * A module with basic scaling will create an instance when the application * receives a request. The instance will be turned down when the app becomes * idle. Basic scaling is ideal for work that is intermittent or driven by * user activity. */ basicScaling: Schema$BasicScaling; /** * Metadata settings that are supplied to this version to enable beta runtime * features. */ betaSettings: any; /** * Time that this version was created.@OutputOnly */ creationTime: string; /** * Duration that static files should be cached by web proxies and browsers. * Only applicable if the corresponding StaticFilesHandler * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) * does not specify its own expiration time.Only returned in GET requests if * view=FULL is set. */ defaultExpiration: string; /** * Email address of the user who created this version.@OutputOnly */ deployer: string; /** * Code and application artifacts that make up this version.Only returned in * GET requests if view=FULL is set. */ deployment: Schema$Deployment; /** * Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud * Endpoints Extensible Service Proxy will be provided to serve the API * implemented by the app. */ endpointsApiService: Schema$EndpointsApiService; /** * App Engine execution environment to use for this version.Defaults to 1. */ env: string; /** * Environment variables made available to the application.Only returned in * GET requests if view=FULL is set. */ envVariables: any; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET * requests if view=FULL is set. */ errorHandlers: Schema$ErrorHandler[]; /** * An ordered list of URL-matching patterns that should be applied to incoming * requests. The first matching URL handles the request and other request * handlers are not attempted.Only returned in GET requests if view=FULL is * set. */ handlers: Schema$UrlMap[]; /** * Configures health checking for VM instances. Unhealthy instances are * stopped and replaced with new instances. Only applicable for VM * runtimes.Only returned in GET requests if view=FULL is set. */ healthCheck: Schema$HealthCheck; /** * Relative name of the version within the module. Example: v1. Version names * can contain only lowercase letters, numbers, or hyphens. Reserved names: * &quot;default&quot;, &quot;latest&quot;, and any name with the prefix * &quot;ah-&quot;. */ id: string; /** * Before an application can receive email or XMPP messages, the application * must be configured to enable the service. */ inboundServices: string[]; /** * Instance class that is used to run this version. Valid values are: * AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, * B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling * or BasicScaling. */ instanceClass: string; /** * Configuration for third-party Python runtime libraries required by the * application.Only returned in GET requests if view=FULL is set. */ libraries: Schema$Library[]; /** * A module with manual scaling runs continuously, allowing you to perform * complex initialization and rely on the state of its memory over time. */ manualScaling: Schema$ManualScaling; /** * Full path to the Version resource in the API. Example: * apps/myapp/modules/default/versions/v1.@OutputOnly */ name: string; /** * Extra network settings. Only applicable for VM runtimes. */ network: Schema$Network; /** * Files that match this pattern will not be built into this version. Only * applicable for Go runtimes.Only returned in GET requests if view=FULL is * set. */ nobuildFilesRegex: string; /** * Machine resources for this version. Only applicable for VM runtimes. */ resources: Schema$Resources; /** * Desired runtime. Example: python27. */ runtime: string; /** * The version of the API in the given runtime environment. Please see the * app.yaml reference for valid values at * https://cloud.google.com/appengine/docs/standard/&lt;language&gt;/config/appref */ runtimeApiVersion: string; /** * Current serving status of this version. Only the versions with a SERVING * status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an * invalid value. Defaults to SERVING. */ servingStatus: string; /** * Whether multiple requests can be dispatched to this version at once. */ threadsafe: boolean; /** * Whether to deploy this version in a container on a virtual machine. */ vm: boolean; } /** * Volumes mounted within the app container. Only applicable for VM runtimes. */ export interface Schema$Volume { /** * Unique name for the volume. */ name: string; /** * Volume size in gigabytes. */ sizeGb: number; /** * Underlying volume type, e.g. &#39;tmpfs&#39;. */ volumeType: string; } export declare class Resource$Apps { root: Appengine; locations: Resource$Apps$Locations; modules: Resource$Apps$Modules; operations: Resource$Apps$Operations; constructor(root: Appengine); getRoot(): Appengine; /** * appengine.apps.create * @desc Creates an App Engine application for a Google Cloud Platform * project. Required fields: id - The ID of the target Cloud Platform project. * location - The region (https://cloud.google.com/appengine/docs/locations) * where you want the App Engine application located.For more information * about App Engine applications, see Managing Projects, Applications, and * Billing (https://cloud.google.com/appengine/docs/python/console/). * @alias appengine.apps.create * @memberOf! () * * @param {object} params Parameters for request * @param {().Application} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: any, options?: MethodOptions): AxiosPromise<Schema$Operation>; create(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Operation>, callback?: BodyResponseCallback<Schema$Operation>): void; /** * appengine.apps.get * @desc Gets information about an application. * @alias appengine.apps.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.appsId Part of `name`. Name of the application to get. Example: apps/myapp. * @param {boolean=} params.ensureResourcesExist Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Application>; get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Application>, callback?: BodyResponseCallback<Schema$Application>): void; /** * appengine.apps.patch * @desc Updates the specified Application resource. You can update the * following fields: auth_domain * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain) * default_cookie_expiration * (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration) * @alias appengine.apps.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.appsId Part of `name`. Name of the Application resource to update. Example: apps/myapp. * @param {string=} params.mask Standard field mask for the set of fields to be updated. * @param {().Application} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: any, options?: MethodOptions): AxiosPromise<Schema$Operation>; patch(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Operation>, callback?: BodyResponseCallback<Schema$Operation>): void; } export declare class Resource$Apps$Locations { root: Appengine; constructor(root: Appengine); getRoot(): Appengine; /** * appengine.apps.locations.get * @desc Gets information about a location.