@googleapis/appengine
Version:
1,142 lines • 340 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 appengine_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* App Engine Admin API
*
* Provisions and manages developers' App Engine applications.
*
* @example
* ```js
* const {google} = require('googleapis');
* const appengine = google.appengine('v1');
* ```
*/
export class Appengine {
context: APIRequestContext;
apps: Resource$Apps;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers.
*/
export interface Schema$ApiConfigHandler {
/**
* Action to take when users access resources that require authentication. Defaults to redirect.
*/
authFailAction?: string | null;
/**
* Level of login required to access this resource. Defaults to optional.
*/
login?: string | null;
/**
* Path to the script from the application root directory.
*/
script?: string | null;
/**
* Security (HTTPS) enforcement for this URL.
*/
securityLevel?: string | null;
/**
* URL to serve the endpoint at.
*/
url?: string | null;
}
/**
* Uses Google Cloud Endpoints to handle requests.
*/
export interface Schema$ApiEndpointHandler {
/**
* Path to the script from the application root directory.
*/
scriptPath?: string | null;
}
/**
* 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 | null;
/**
* Output only. 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 | null;
/**
* The type of the Cloud Firestore or Cloud Datastore database associated with this application.
*/
databaseType?: string | null;
/**
* Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
*/
defaultBucket?: string | null;
/**
* Cookie expiration policy for this application.
*/
defaultCookieExpiration?: string | null;
/**
* Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly
*/
defaultHostname?: string | null;
/**
* HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
*/
dispatchRules?: Schema$UrlDispatchRule[];
/**
* The feature specific settings to be used in the application.
*/
featureSettings?: Schema$FeatureSettings;
/**
* Output only. The Google Container Registry domain used for storing managed build docker images for this application.
*/
gcrDomain?: string | null;
/**
* Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
*/
generatedCustomerMetadata?: {
[key: string]: any;
} | null;
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 | null;
/**
* Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
*/
locationId?: string | null;
name?: string | null;
/**
* The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
*/
serviceAccount?: string | null;
/**
* Serving status of this application.
*/
servingStatus?: string | null;
/**
* The SSL policy that will be applied to the application. If set to Modern it will restrict traffic with TLS < 1.2 and allow only Modern Ciphers suite
*/
sslPolicy?: string | null;
}
/**
* An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
*/
export interface Schema$AuthorizedCertificate {
/**
* The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
*/
certificateRawData?: Schema$CertificateRawData;
/**
* The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
*/
displayName?: string | null;
/**
* Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
domainMappingsCount?: number | null;
/**
* Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
*/
domainNames?: string[] | null;
/**
* The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
*/
expireTime?: string | null;
/**
* Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
*/
id?: string | null;
/**
* Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
*/
managedCertificate?: Schema$ManagedCertificate;
/**
* Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
*/
name?: string | null;
/**
* The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
visibleDomainMappings?: string[] | null;
}
/**
* A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console (https://search.google.com/search-console/welcome).
*/
export interface Schema$AuthorizedDomain {
/**
* Fully qualified domain name of the domain authorized for use. Example: example.com.
*/
id?: string | null;
/**
* Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly
*/
name?: string | null;
}
/**
* Automatic scaling is based on request rate, response latencies, and other application metrics.
*/
export interface Schema$AutomaticScaling {
/**
* The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
*/
coolDownPeriod?: string | null;
/**
* 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 | null;
/**
* Maximum number of idle instances that should be maintained for this version.
*/
maxIdleInstances?: number | null;
/**
* Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
*/
maxPendingLatency?: string | null;
/**
* Maximum number of instances that should be started to handle requests for this version.
*/
maxTotalInstances?: number | null;
/**
* Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
*/
minIdleInstances?: number | null;
/**
* Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
*/
minPendingLatency?: string | null;
/**
* Minimum number of running instances that should be maintained for this version.
*/
minTotalInstances?: number | null;
/**
* Target scaling by network usage.
*/
networkUtilization?: Schema$NetworkUtilization;
/**
* Target scaling by request utilization.
*/
requestUtilization?: Schema$RequestUtilization;
/**
* Scheduler settings for standard environment.
*/
standardSchedulerSettings?: Schema$StandardSchedulerSettings;
}
/**
* A service 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 | null;
/**
* Maximum number of instances to create for this version.
*/
maxInstances?: number | null;
}
/**
* Request message for Firewall.BatchUpdateIngressRules.
*/
export interface Schema$BatchUpdateIngressRulesRequest {
/**
* A list of FirewallRules to replace the existing set.
*/
ingressRules?: Schema$FirewallRule[];
}
/**
* Response message for Firewall.UpdateAllIngressRules.
*/
export interface Schema$BatchUpdateIngressRulesResponse {
/**
* The full list of ingress FirewallRules for this application.
*/
ingressRules?: Schema$FirewallRule[];
}
/**
* An SSL certificate obtained from a certificate authority.
*/
export interface Schema$CertificateRawData {
/**
* Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly
*/
privateKey?: string | null;
/**
* PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
*/
publicCertificate?: string | null;
}
/**
* Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.
*/
export interface Schema$CloudBuildOptions {
/**
* Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
*/
appYamlPath?: string | null;
/**
* The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
*/
cloudBuildTimeout?: string | null;
}
/**
* 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: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
*/
image?: string | null;
}
/**
* ContainerState contains the externally-visible container state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the container state.
*/
export interface Schema$ContainerState {
currentReasons?: Schema$Reasons;
/**
* The previous and current reasons for a container state will be sent for a container event. CLHs that need to know the signal that caused the container event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.
*/
previousReasons?: Schema$Reasons;
/**
* The current state of the container. This state is the culmination of all of the opinions from external systems that CCFE knows about of the container.
*/
state?: string | null;
}
/**
* Target scaling by CPU usage.
*/
export interface Schema$CpuUtilization {
/**
* Period of time over which CPU utilization is calculated.
*/
aggregationWindowLength?: string | null;
/**
* Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
*/
targetUtilization?: number | null;
}
/**
* 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 | null;
}
/**
* 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 | null;
}
/**
* 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 | null;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date).Related types: google.type.TimeOfDay google.type.DateTime google.protobuf.Timestamp
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* 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 {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"\}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
*/
sshKey?: string | null;
}
/**
* Code and application artifacts used to deploy a version to App Engine.
*/
export interface Schema$Deployment {
/**
* Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
*/
cloudBuildOptions?: Schema$CloudBuildOptions;
/**
* 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?: {
[key: string]: Schema$FileInfo;
} | null;
/**
* The zip file for this deployment, if this is a zip deployment.
*/
zip?: Schema$ZipInfo;
}
/**
* Target scaling by disk usage. Only applicable in the App Engine flexible environment.
*/
export interface Schema$DiskUtilization {
/**
* Target bytes read per second.
*/
targetReadBytesPerSecond?: number | null;
/**
* Target ops read per seconds.
*/
targetReadOpsPerSecond?: number | null;
/**
* Target bytes written per second.
*/
targetWriteBytesPerSecond?: number | null;
/**
* Target ops written per second.
*/
targetWriteOpsPerSecond?: number | null;
}
/**
* A domain serving an App Engine application.
*/
export interface Schema$DomainMapping {
/**
* Relative name of the domain serving the application. Example: example.com.
*/
id?: string | null;
/**
* Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
*/
name?: string | null;
/**
* The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
*/
resourceRecords?: Schema$ResourceRecord[];
/**
* SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
*/
sslSettings?: Schema$SslSettings;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Google 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 "service" 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 "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
*/
configId?: string | null;
/**
* Enable or disable trace sampling. By default, this is set to false for enabled.
*/
disableTraceSampling?: boolean | null;
/**
* Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
*/
name?: string | null;
/**
* Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
*/
rolloutStrategy?: string | null;
}
/**
* The entrypoint for the application.
*/
export interface Schema$Entrypoint {
/**
* The format should be a shell command that can be fed to bash -c.
*/
shell?: string | null;
}
/**
* Custom static error page to be served when an error occurs.
*/
export interface Schema$ErrorHandler {
/**
* Error condition this handler applies to.
*/
errorCode?: string | null;
/**
* MIME type of file. Defaults to text/html.
*/
mimeType?: string | null;
/**
* Static file content to be served for this error.
*/
staticFile?: string | null;
}
/**
* The feature specific settings to be used in the application. These define behaviors that are user configurable.
*/
export interface Schema$FeatureSettings {
/**
* Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
*/
splitHealthChecks?: boolean | null;
/**
* If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.
*/
useContainerOptimizedOs?: boolean | null;
}
/**
* 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 | null;
/**
* The SHA1 hash of the file, in hex.
*/
sha1Sum?: string | null;
/**
* URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
*/
sourceUrl?: string | null;
}
/**
* A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests. A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
*/
export interface Schema$FirewallRule {
/**
* The action to take on matched requests.
*/
action?: string | null;
/**
* An optional string description of this rule. This field has a maximum length of 400 characters.
*/
description?: string | null;
priority?: number | null;
/**
* IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
*/
sourceRange?: string | null;
}
/**
* Runtime settings for the App Engine flexible environment.
*/
export interface Schema$FlexibleRuntimeSettings {
/**
* The operating system of the application runtime.
*/
operatingSystem?: string | null;
/**
* The runtime version of an App Engine flexible application.
*/
runtimeVersion?: string | null;
}
/**
* For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.
*/
export interface Schema$GceTag {
/**
* The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.
*/
parent?: string[] | null;
/**
* The administrative_tag name.
*/
tag?: string | null;
}
/**
* Metadata for the given google.cloud.location.Location.
*/
export interface Schema$GoogleAppengineV1betaLocationMetadata {
/**
* App Engine flexible environment is available in the given location.@OutputOnly
*/
flexibleEnvironmentAvailable?: boolean | null;
/**
* Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.
*/
searchApiAvailable?: boolean | null;
/**
* App Engine standard environment is available in the given location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean | null;
}
/**
* 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 | null;
/**
* Whether to explicitly disable health checks for this instance.
*/
disableHealthCheck?: boolean | null;
/**
* Number of consecutive successful health checks required before receiving traffic.
*/
healthyThreshold?: number | null;
/**
* Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
*/
host?: string | null;
/**
* Number of consecutive failed health checks required before an instance is restarted.
*/
restartThreshold?: number | null;
/**
* Time before the health check is considered failed.
*/
timeout?: string | null;
/**
* Number of consecutive failed health checks required before removing traffic.
*/
unhealthyThreshold?: number | null;
}
/**
* 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 | null;
/**
* OAuth2 client ID to use for the authentication flow.
*/
oauth2ClientId?: string | null;
/**
* OAuth2 client secret to use for the authentication flow.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 | null;
/**
* Output only. Hex-encoded SHA-256 hash of the client secret.@OutputOnly
*/
oauth2ClientSecretSha256?: string | null;
}
/**
* An Instance resource is the computing unit that App Engine uses to automatically scale an application.
*/
export interface Schema$Instance {
/**
* Output only. App Engine release this instance is running on.
*/
appEngineRelease?: string | null;
/**
* Output only. Availability of the instance.
*/
availability?: string | null;
/**
* Output only. Average latency (ms) over the last minute.
*/
averageLatency?: number | null;
/**
* Output only. Number of errors since this instance was started.
*/
errors?: number | null;
/**
* Output only. Relative name of the instance within the version. Example: instance-1.
*/
id?: string | null;
/**
* Output only. Total memory in use (bytes).
*/
memoryUsage?: string | null;
/**
* Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.
*/
name?: string | null;
/**
* Output only. Average queries per second (QPS) over the last minute.
*/
qps?: number | null;
/**
* Output only. Number of requests since this instance was started.
*/
requests?: number | null;
/**
* Output only. Time that this instance was started.@OutputOnly
*/
startTime?: string | null;
/**
* Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
*/
vmDebugEnabled?: boolean | null;
/**
* Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
*/
vmId?: string | null;
/**
* Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
*/
vmIp?: string | null;
/**
* Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
*/
vmLiveness?: string | null;
/**
* Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
*/
vmName?: string | null;
/**
* Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
*/
vmStatus?: string | null;
/**
* Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.
*/
vmZoneName?: string | null;
}
/**
* Third-party Python runtime library that is required by the application.
*/
export interface Schema$Library {
/**
* Name of the library. Example: "django".
*/
name?: string | null;
/**
* Version of the library to select, or "latest".
*/
version?: string | null;
}
/**
* Response message for AuthorizedCertificates.ListAuthorizedCertificates.
*/
export interface Schema$ListAuthorizedCertificatesResponse {
/**
* The SSL certificates the user is authorized to administer.
*/
certificates?: Schema$AuthorizedCertificate[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for AuthorizedDomains.ListAuthorizedDomains.
*/
export interface Schema$ListAuthorizedDomainsResponse {
/**
* The authorized domains belonging to the user.
*/
domains?: Schema$AuthorizedDomain[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for DomainMappings.ListDomainMappings.
*/
export interface Schema$ListDomainMappingsResponse {
/**
* The domain mappings for the application.
*/
domainMappings?: Schema$DomainMapping[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for Firewall.ListIngressRules.
*/
export interface Schema$ListIngressRulesResponse {
/**
* The ingress FirewallRules for this application.
*/
ingressRules?: Schema$FirewallRule[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* 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 | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
/**
* Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.
*/
unreachable?: string[] | null;
}
/**
* Response message for Applications.ListRuntimes.
*/
export interface Schema$ListRuntimesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* The runtimes available to the requested application.
*/
runtimes?: Schema$Runtime[];
}
/**
* Response message for Services.ListServices.
*/
export interface Schema$ListServicesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* The services belonging to the requested application.
*/
services?: Schema$Service[];
}
/**
* Response message for Versions.ListVersions.
*/
export interface Schema$ListVersionsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* The versions belonging to the requested service.
*/
versions?: Schema$Version[];
}
/**
* Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
*/
export interface Schema$LivenessCheck {
/**
* Interval between health checks.
*/
checkInterval?: string | null;
/**
* Number of consecutive failed checks required before considering the VM unhealthy.
*/
failureThreshold?: number | null;
/**
* Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
*/
host?: string | null;
/**
* The initial delay before starting to execute the checks.
*/
initialDelay?: string | null;
/**
* The request path.
*/
path?: string | null;
/**
* Number of consecutive successful checks required before considering the VM healthy.
*/
successThreshold?: number | null;
/**
* Time before the check is considered failed.
*/
timeout?: string | null;
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: "us-east1".
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
*/
name?: string | null;
}
/**
* 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 | null;
/**
* Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.
*/
searchApiAvailable?: boolean | null;
/**
* App Engine standard environment is available in the given location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean | null;
}
/**
* A certificate managed by App Engine.
*/
export interface Schema$ManagedCertificate {
/**
* Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly
*/
lastRenewalTime?: string | null;
/**
* Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly
*/
status?: string | null;
}
/**
* A service 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 service 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 | null;
}
/**
* Extra network settings. Only applicable in the App Engine flexible environment.
*/
export interface Schema$Network {
/**
* List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
*/
forwardedPorts?: string[] | null;
/**
* The IP mode for instances. Only applicable in the App Engine flexible environment.
*/
instanceIpMode?: string | null;
/**
* Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
*/
instanceTag?: string | null;
/**
* Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
*/
name?: string | null;
/**
* Enable session affinity. Only applicable in the App Engine flexible environment.
*/
sessionAffinity?: boolean | null;
/**
* Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
*/
subnetworkName?: string | null;
}
/**
* A NetworkSettings resource is a container for ingress settings for a version or service.
*/
export interface Schema$NetworkSettings {
/**
* The ingress settings for version or service.
*/
ingressTrafficAllowed?: string | null;
}
/**
* Target scaling by network usage. Only applicable in the App Engine flexible environment.
*/
export interface Schema$NetworkUtilization {
/**
* Target bytes received per second.
*/
targetReceivedBytesPerSecond?: number | null;
/**
* Target packets received per second.
*/
targetReceivedPacketsPerSecond?: number | null;
/**
* Target bytes sent per second.
*/
targetSentBytesPerSecond?: number | null;
/**
* Target packets sent per second.
*/
targetSentPacketsPerSecond?: number | null;
}
/**
* 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 | null;
/**
* 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?: {
[key: string]: any;
} | null;
/**
* 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 be a resource name ending with operations/{unique_id\}.
*/
name?: string | null;
/**
* The normal, successful response of the operation. 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?: {
[key: string]: any;
} | null;
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema$OperationMetadataV1 {
createVersionMetadata?: Schema$CreateVersionMetadataV1;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string | null;
/**
* Ephemeral message that may change every time the operation is polled. @OutputOnly
*/
ephemeralMessage?: string | null;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string | null;
/**
* API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly
*/
method?: string | null;
/**
* Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly
*/
target?: string | null;
/**
* User who requested this operation.@OutputOnly
*/
user?: string | null;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[] | null;
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema