Package-level declarations

Types

Link copied to clipboard
data class ApiConfigHandlerResponse(val authFailAction: String, val login: String, val script: String, val securityLevel: String, val url: String)

Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers.

Link copied to clipboard
data class ApiEndpointHandlerResponse(val scriptPath: String)

Uses Google Cloud Endpoints to handle requests.

Link copied to clipboard
data class AutomaticScalingResponse(val coolDownPeriod: String, val cpuUtilization: CpuUtilizationResponse, val customMetrics: List<CustomMetricResponse>, val diskUtilization: DiskUtilizationResponse, val maxConcurrentRequests: Int, val maxIdleInstances: Int, val maxPendingLatency: String, val maxTotalInstances: Int, val minIdleInstances: Int, val minPendingLatency: String, val minTotalInstances: Int, val networkUtilization: NetworkUtilizationResponse, val requestUtilization: RequestUtilizationResponse, val standardSchedulerSettings: StandardSchedulerSettingsResponse)

Automatic scaling is based on request rate, response latencies, and other application metrics.

Link copied to clipboard
data class BasicScalingResponse(val idleTimeout: String, val maxInstances: Int)

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.

Link copied to clipboard
data class BuildInfoResponse(val cloudBuildId: String)

Google Cloud Build information.

Link copied to clipboard
data class CertificateRawDataResponse(val privateKey: String, val publicCertificate: String)

An SSL certificate obtained from a certificate authority.

Link copied to clipboard
data class CloudBuildOptionsResponse(val appYamlPath: String, val cloudBuildTimeout: String)

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.

Link copied to clipboard
data class ContainerInfoResponse(val image: String)

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.

Link copied to clipboard
data class CpuUtilizationResponse(val aggregationWindowLength: String, val targetUtilization: Double)

Target scaling by CPU usage.

Link copied to clipboard
data class CustomMetricResponse(val filter: String, val metricName: String, val singleInstanceAssignment: Double, val targetType: String, val targetUtilization: Double)

Allows autoscaling based on Stackdriver metrics.

Link copied to clipboard
data class DeploymentResponse(val build: BuildInfoResponse, val cloudBuildOptions: CloudBuildOptionsResponse, val container: ContainerInfoResponse, val files: Map<String, String>, val zip: ZipInfoResponse)

Code and application artifacts used to deploy a version to App Engine.

Link copied to clipboard
data class DiskUtilizationResponse(val targetReadBytesPerSecond: Int, val targetReadOpsPerSecond: Int, val targetWriteBytesPerSecond: Int, val targetWriteOpsPerSecond: Int)

Target scaling by disk usage. Only applicable in the App Engine flexible environment.

Link copied to clipboard
data class EndpointsApiServiceResponse(val configId: String, val disableTraceSampling: Boolean, val name: String, val rolloutStrategy: String)

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).

Link copied to clipboard
data class EntrypointResponse(val shell: String)

The entrypoint for the application.

Link copied to clipboard
data class ErrorHandlerResponse(val errorCode: String, val mimeType: String, val staticFile: String)

Custom static error page to be served when an error occurs.

Link copied to clipboard
data class FeatureSettingsResponse(val splitHealthChecks: Boolean, val useContainerOptimizedOs: Boolean)

The feature specific settings to be used in the application. These define behaviors that are user configurable.

Link copied to clipboard
data class FlexibleRuntimeSettingsResponse(val operatingSystem: String, val runtimeVersion: String)

Runtime settings for the App Engine flexible environment.

Link copied to clipboard
data class GetApplicationResult(val authDomain: String, val codeBucket: String, val databaseType: String, val defaultBucket: String, val defaultCookieExpiration: String, val defaultHostname: String, val dispatchRules: List<UrlDispatchRuleResponse>, val featureSettings: FeatureSettingsResponse, val gcrDomain: String, val iap: IdentityAwareProxyResponse, val location: String, val name: String, val serviceAccount: String, val servingStatus: String)
Link copied to clipboard
data class GetAppResult(val authDomain: String, val codeBucket: String, val databaseType: String, val defaultBucket: String, val defaultCookieExpiration: String, val defaultHostname: String, val dispatchRules: List<UrlDispatchRuleResponse>, val featureSettings: FeatureSettingsResponse, val gcrDomain: String, val iap: IdentityAwareProxyResponse, val location: String, val name: String, val serviceAccount: String, val servingStatus: String)
Link copied to clipboard
data class GetAuthorizedCertificateResult(val certificateRawData: CertificateRawDataResponse, val displayName: String, val domainMappingsCount: Int, val domainNames: List<String>, val expireTime: String, val managedCertificate: ManagedCertificateResponse, val name: String, val visibleDomainMappings: List<String>)
Link copied to clipboard
data class GetDomainMappingResult(val name: String, val resourceRecords: List<ResourceRecordResponse>, val sslSettings: SslSettingsResponse)
Link copied to clipboard
data class GetIngressRuleResult(val action: String, val description: String, val priority: Int, val sourceRange: String)
Link copied to clipboard
data class GetVersionResult(val apiConfig: ApiConfigHandlerResponse, val appEngineApis: Boolean, val automaticScaling: AutomaticScalingResponse, val basicScaling: BasicScalingResponse, val betaSettings: Map<String, String>, val buildEnvVariables: Map<String, String>, val createTime: String, val createdBy: String, val defaultExpiration: String, val deployment: DeploymentResponse, val diskUsageBytes: String, val endpointsApiService: EndpointsApiServiceResponse, val entrypoint: EntrypointResponse, val env: String, val envVariables: Map<String, String>, val errorHandlers: List<ErrorHandlerResponse>, val flexibleRuntimeSettings: FlexibleRuntimeSettingsResponse, val handlers: List<UrlMapResponse>, val healthCheck: HealthCheckResponse, val inboundServices: List<String>, val instanceClass: String, val libraries: List<LibraryResponse>, val livenessCheck: LivenessCheckResponse, val manualScaling: ManualScalingResponse, val name: String, val network: NetworkResponse, val nobuildFilesRegex: String, val readinessCheck: ReadinessCheckResponse, val resources: ResourcesResponse, val runtime: String, val runtimeApiVersion: String, val runtimeChannel: String, val runtimeMainExecutablePath: String, val serviceAccount: String, val servingStatus: String, val threadsafe: Boolean, val versionUrl: String, val vm: Boolean, val vpcAccessConnector: VpcAccessConnectorResponse, val zones: List<String>)
Link copied to clipboard
data class HealthCheckResponse(val checkInterval: String, val disableHealthCheck: Boolean, val healthyThreshold: Int, val host: String, val restartThreshold: Int, val timeout: String, val unhealthyThreshold: Int)

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.

Link copied to clipboard
data class IdentityAwareProxyResponse(val enabled: Boolean, val oauth2ClientId: String, val oauth2ClientSecret: String, val oauth2ClientSecretSha256: String)

Identity-Aware Proxy

Link copied to clipboard
data class LibraryResponse(val name: String, val version: String)

Third-party Python runtime library that is required by the application.

Link copied to clipboard
data class LivenessCheckResponse(val checkInterval: String, val failureThreshold: Int, val host: String, val initialDelay: String, val path: String, val successThreshold: Int, val timeout: String)

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.

Link copied to clipboard
data class ManagedCertificateResponse(val lastRenewalTime: String, val status: String)

A certificate managed by App Engine.

Link copied to clipboard
data class ManualScalingResponse(val instances: Int)

A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.

Link copied to clipboard
data class NetworkResponse(val forwardedPorts: List<String>, val instanceIpMode: String, val instanceTag: String, val name: String, val sessionAffinity: Boolean, val subnetworkName: String)

Extra network settings. Only applicable in the App Engine flexible environment.

Link copied to clipboard
data class NetworkUtilizationResponse(val targetReceivedBytesPerSecond: Int, val targetReceivedPacketsPerSecond: Int, val targetSentBytesPerSecond: Int, val targetSentPacketsPerSecond: Int)

Target scaling by network usage. Only applicable in the App Engine flexible environment.

Link copied to clipboard
data class ReadinessCheckResponse(val appStartTimeout: String, val checkInterval: String, val failureThreshold: Int, val host: String, val path: String, val successThreshold: Int, val timeout: String)

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

Link copied to clipboard
data class RequestUtilizationResponse(val targetConcurrentRequests: Int, val targetRequestCountPerSecond: Int)

Target scaling by request utilization. Only applicable in the App Engine flexible environment.

Link copied to clipboard
data class ResourceRecordResponse(val name: String, val rrdata: String, val type: String)

A DNS resource record.

Link copied to clipboard
data class ResourcesResponse(val cpu: Double, val diskGb: Double, val kmsKeyReference: String, val memoryGb: Double, val volumes: List<VolumeResponse>)

Machine resources for a version.

Link copied to clipboard
data class ScriptHandlerResponse(val scriptPath: String)

Executes a script to handle the request that matches the URL pattern.

Link copied to clipboard
data class SslSettingsResponse(val certificateId: String, val pendingManagedCertificateId: String, val sslManagementType: String)

SSL configuration for a DomainMapping resource.

Link copied to clipboard
data class StandardSchedulerSettingsResponse(val maxInstances: Int, val minInstances: Int, val targetCpuUtilization: Double, val targetThroughputUtilization: Double)

Scheduler settings for standard environment.

Link copied to clipboard
data class StaticFilesHandlerResponse(val applicationReadable: Boolean, val expiration: String, val httpHeaders: Map<String, String>, val mimeType: String, val path: String, val requireMatchingFile: Boolean, val uploadPathRegex: String)

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.

Link copied to clipboard
data class UrlDispatchRuleResponse(val domain: String, val path: String, val service: String)

Rules to match an HTTP request and dispatch that request to a service.

Link copied to clipboard
data class UrlMapResponse(val apiEndpoint: ApiEndpointHandlerResponse, val authFailAction: String, val login: String, val redirectHttpResponseCode: String, val script: ScriptHandlerResponse, val securityLevel: String, val staticFiles: StaticFilesHandlerResponse, val urlRegex: 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.

Link copied to clipboard
data class VolumeResponse(val name: String, val sizeGb: Double, val volumeType: String)

Volumes mounted within the app container. Only applicable in the App Engine flexible environment.

Link copied to clipboard
data class VpcAccessConnectorResponse(val egressSetting: String, val name: String)

VPC access connector specification.

Link copied to clipboard
data class ZipInfoResponse(val filesCount: Int, val sourceUrl: String)

The zip file information for a zip deployment.