appenginestandardappversion_v1alpha1.json

{
  "properties": {
    "apiVersion": {
      "description": "apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "properties": {
        "appEngineApis": {
          "description": "Allows App Engine second generation runtimes to access the legacy bundled services.",
          "type": "boolean"
        },
        "automaticScaling": {
          "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
          "properties": {
            "maxConcurrentRequests": {
              "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.\n\nDefaults to a runtime-specific value.",
              "type": "integer"
            },
            "maxIdleInstances": {
              "description": "Maximum number of idle instances that should be maintained for this version.",
              "type": "integer"
            },
            "maxPendingLatency": {
              "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".",
              "type": "string"
            },
            "minIdleInstances": {
              "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
              "type": "integer"
            },
            "minPendingLatency": {
              "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".",
              "type": "string"
            },
            "standardSchedulerSettings": {
              "description": "Scheduler settings for standard environment.",
              "properties": {
                "maxInstances": {
                  "description": "Maximum number of instances to run for this version. Set to zero to disable maxInstances configuration.",
                  "type": "integer"
                },
                "minInstances": {
                  "description": "Minimum number of instances to run for this version. Set to zero to disable minInstances configuration.",
                  "type": "integer"
                },
                "targetCpuUtilization": {
                  "description": "Target CPU utilization ratio to maintain when scaling. Should be a value in the range [0.50, 0.95], zero, or a negative value.",
                  "type": "number"
                },
                "targetThroughputUtilization": {
                  "description": "Target throughput utilization ratio to maintain when scaling. Should be a value in the range [0.50, 0.95], zero, or a negative value.",
                  "type": "number"
                }
              },
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "basicScaling": {
          "description": "Basic scaling creates instances when your application receives requests. Each instance will be shut down when the application becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
          "properties": {
            "idleTimeout": {
              "description": "Duration of time after the last request that an instance must wait before the instance is shut down.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\". Defaults to 900s.",
              "type": "string"
            },
            "maxInstances": {
              "description": "Maximum number of instances to create for this version. Must be in the range [1.0, 200.0].",
              "type": "integer"
            }
          },
          "required": [
            "maxInstances"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "deleteServiceOnDestroy": {
          "description": "If set to 'true', the service will be deleted if it is the last version.",
          "type": "boolean"
        },
        "deployment": {
          "description": "Code and application artifacts that make up this version.",
          "properties": {
            "files": {
              "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version.\nAll files must be readable using the credentials supplied with this call.",
              "items": {
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "sha1Sum": {
                    "description": "SHA1 checksum of the file.",
                    "type": "string"
                  },
                  "sourceUrl": {
                    "description": "Source URL.",
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "sourceUrl"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "zip": {
              "description": "Zip File.",
              "properties": {
                "filesCount": {
                  "description": "files count.",
                  "type": "integer"
                },
                "sourceUrl": {
                  "description": "Source URL.",
                  "type": "string"
                }
              },
              "required": [
                "sourceUrl"
              ],
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "entrypoint": {
          "description": "The entrypoint for the application.",
          "properties": {
            "shell": {
              "description": "The format should be a shell command that can be fed to bash -c.",
              "type": "string"
            }
          },
          "required": [
            "shell"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "envVariables": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Environment variables available to the application.",
          "type": "object"
        },
        "handlers": {
          "description": "An ordered list of URL-matching patterns that should be applied to incoming requests.\nThe first matching URL handles the request and other request handlers are not attempted.",
          "items": {
            "properties": {
              "authFailAction": {
                "description": "Actions to take when the user is not logged in. Possible values: [\"AUTH_FAIL_ACTION_REDIRECT\", \"AUTH_FAIL_ACTION_UNAUTHORIZED\"].",
                "type": "string"
              },
              "login": {
                "description": "Methods to restrict access to a URL based on login status. Possible values: [\"LOGIN_OPTIONAL\", \"LOGIN_ADMIN\", \"LOGIN_REQUIRED\"].",
                "type": "string"
              },
              "redirectHttpResponseCode": {
                "description": "30x code to use when performing redirects for the secure field. Possible values: [\"REDIRECT_HTTP_RESPONSE_CODE_301\", \"REDIRECT_HTTP_RESPONSE_CODE_302\", \"REDIRECT_HTTP_RESPONSE_CODE_303\", \"REDIRECT_HTTP_RESPONSE_CODE_307\"].",
                "type": "string"
              },
              "script": {
                "description": "Executes a script to handle the requests that match this URL pattern.\nOnly the auto value is supported for Node.js in the App Engine standard environment, for example \"script:\" \"auto\".",
                "properties": {
                  "scriptPath": {
                    "description": "Path to the script from the application root directory.",
                    "type": "string"
                  }
                },
                "required": [
                  "scriptPath"
                ],
                "type": "object",
                "additionalProperties": false
              },
              "securityLevel": {
                "description": "Security (HTTPS) enforcement for this URL. Possible values: [\"SECURE_DEFAULT\", \"SECURE_NEVER\", \"SECURE_OPTIONAL\", \"SECURE_ALWAYS\"].",
                "type": "string"
              },
              "staticFiles": {
                "description": "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.",
                "properties": {
                  "applicationReadable": {
                    "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as\nstatic data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged\nagainst both your code and static data storage resource quotas.",
                    "type": "boolean"
                  },
                  "expiration": {
                    "description": "Time a static file served by this handler should be cached by web proxies and browsers.\nA duration in seconds with up to nine fractional digits, terminated by 's'. Example \"3.5s\".",
                    "type": "string"
                  },
                  "httpHeaders": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "description": "HTTP headers to use for all responses from these URLs.\nAn object containing a list of \"key:value\" value pairs.\".",
                    "type": "object"
                  },
                  "mimeType": {
                    "description": "MIME type used to serve all files served by this handler.\nDefaults to file-specific MIME types, which are derived from each file's filename extension.",
                    "type": "string"
                  },
                  "path": {
                    "description": "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.",
                    "type": "string"
                  },
                  "requireMatchingFile": {
                    "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
                    "type": "boolean"
                  },
                  "uploadPathRegex": {
                    "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "urlRegex": {
                "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings.\nAll 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.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "inboundServices": {
          "description": "A list of the types of messages that this application is able to receive. Possible values: [\"INBOUND_SERVICE_MAIL\", \"INBOUND_SERVICE_MAIL_BOUNCE\", \"INBOUND_SERVICE_XMPP_ERROR\", \"INBOUND_SERVICE_XMPP_MESSAGE\", \"INBOUND_SERVICE_XMPP_SUBSCRIBE\", \"INBOUND_SERVICE_XMPP_PRESENCE\", \"INBOUND_SERVICE_CHANNEL_PRESENCE\", \"INBOUND_SERVICE_WARMUP\"].",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "instanceClass": {
          "description": "Instance class that is used to run this version. Valid values are\nAutomaticScaling: F1, F2, F4, F4_1G\nBasicScaling or ManualScaling: B1, B2, B4, B4_1G, B8\nDefaults to F1 for AutomaticScaling and B2 for ManualScaling and BasicScaling. If no scaling is specified, AutomaticScaling is chosen.",
          "type": "string"
        },
        "libraries": {
          "description": "Configuration for third-party Python runtime libraries that are required by the application.",
          "items": {
            "properties": {
              "name": {
                "description": "Name of the library. Example \"django\".",
                "type": "string"
              },
              "version": {
                "description": "Version of the library to select, or \"latest\".",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "manualScaling": {
          "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
          "properties": {
            "instances": {
              "description": "Number of instances to assign to the service at the start.\n\n**Note:** When managing the number of instances at runtime through the App Engine Admin API or the (now deprecated) Python 2\nModules API set_num_instances() you must use 'lifecycle.ignore_changes = [\"manual_scaling\"[0].instances]' to prevent drift detection.",
              "type": "integer"
            }
          },
          "required": [
            "instances"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "noopOnDestroy": {
          "description": "If set to 'true', the application version will not be deleted.",
          "type": "boolean"
        },
        "project": {
          "description": "Immutable.",
          "type": "string"
        },
        "resourceID": {
          "description": "Immutable. Optional. The versionId of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.",
          "type": "string"
        },
        "runtime": {
          "description": "Desired runtime. Example python27.",
          "type": "string"
        },
        "runtimeApiVersion": {
          "description": "The version of the API in the given runtime environment.\nPlease see the app.yaml reference for valid values at 'https://cloud.google.com/appengine/docs/standard/<language>/config/appref'\\\nSubstitute '<language>' with 'python', 'java', 'php', 'ruby', 'go' or 'nodejs'.",
          "type": "string"
        },
        "serviceAccount": {
          "description": "The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.",
          "type": "string"
        },
        "serviceRef": {
          "oneOf": [
            {
              "not": {
                "required": [
                  "external"
                ]
              },
              "required": [
                "name"
              ]
            },
            {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "name"
                    ]
                  },
                  {
                    "required": [
                      "namespace"
                    ]
                  }
                ]
              },
              "required": [
                "external"
              ]
            }
          ],
          "properties": {
            "external": {
              "description": "Allowed value: The `name` field of an `AppEngineService` resource.",
              "type": "string"
            },
            "name": {
              "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
              "type": "string"
            },
            "namespace": {
              "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "threadsafe": {
          "description": "Whether multiple requests can be dispatched to this version at once.",
          "type": "boolean"
        },
        "vpcAccessConnector": {
          "description": "Enables VPC connectivity for standard apps.",
          "properties": {
            "egressSetting": {
              "description": "The egress setting for the connector, controlling what traffic is diverted through it.",
              "type": "string"
            },
            "name": {
              "description": "Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.",
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "deployment",
        "entrypoint",
        "runtime",
        "serviceRef"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "properties": {
        "conditions": {
          "description": "Conditions represent the latest available observation of the resource's current state.",
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "Last time the condition transitioned from one status to another.",
                "type": "string"
              },
              "message": {
                "description": "Human-readable message indicating details about last transition.",
                "type": "string"
              },
              "reason": {
                "description": "Unique, one-word, CamelCase reason for the condition's last transition.",
                "type": "string"
              },
              "status": {
                "description": "Status is the status of the condition. Can be True, False, Unknown.",
                "type": "string"
              },
              "type": {
                "description": "Type is the type of the condition.",
                "type": "string"
              }
            },
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "name": {
          "description": "Full path to the Version resource in the API. Example, \"v1\".",
          "type": "string"
        },
        "observedGeneration": {
          "description": "ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.",
          "type": "integer"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "spec"
  ],
  "type": "object"
}