REST Resource: projects.locations.spaces.applications

Resource: Application

Represents the application resource.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "source": {
    object (DeploymentSource)
  },
  "appParameters": [
    {
      object (Parameter)
    }
  ],
  "componentParameters": [
    {
      object (ComponentParameters)
    }
  ],
  "serviceAccount": string,
  "displayName": string,
  "description": string,
  "attributes": {
    object (Attributes)
  },
  "scope": {
    object (Scope)
  },
  "importExistingResources": boolean,
  "previewReference": string,
  "deploymentRevision": string,
  "apphubApplication": string,
  "serializedApplicationTemplate": {
    object (SerializedApplicationTemplate)
  },
  "state": enum (State),
  "deploymentMetadata": {
    object (DeploymentMetadata)
  },
  "projectParameters": [
    {
      object (ProjectParameters)
    }
  ],
  "deploymentRegion": string,
  "updatedTemplateRevision": {
    object (UpdatedTemplateRevision)
  },
  "deploymentProject": string
}
Fields
name

string

Identifier. The name of the application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}
createTime

string (Timestamp format)

Output only. Create timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
source

object (DeploymentSource)

Optional. The application deployment source.
appParameters[]

object (Parameter)

Optional. A list of parameters to attach to the deployment source object, which is a catalog entry or application template snapshot.
componentParameters[]

object (ComponentParameters)

Optional. A list of component parameters to associate with the application.
serviceAccount

string

Optional. Your own service account that you use to deploy an application.
displayName

string

Optional. Display name of the application.
description

string

Optional. Description of the application.
attributes

object (Attributes)

Optional. Attributes of the application.
scope

object (Scope)

Optional. Scope of the application.
importExistingResources

boolean

Optional. Import existing resources into the application.
previewReference

string

Output only. Preview reference for the application.
deploymentRevision

string

Output only. [Output only] Optional Infra Manager deployment Id with revision
apphubApplication

string

Output only. The App Hub App associated with the application.
serializedApplicationTemplate

object (SerializedApplicationTemplate)

Output only. [Output only] Serialized application template.
state

enum (State)

Output only. Deployment state of the application.
deploymentMetadata

object (DeploymentMetadata)

Output only. Deployment metadata of the application.
projectParameters[]

object (ProjectParameters)

Output only. List of project parameters for the application.
deploymentRegion

string

Optional. The region where the application is deployed.
updatedTemplateRevision

object (UpdatedTemplateRevision)

Output only. The updated template revision because of which the application is outdated.
deploymentProject

string

Optional. Deployment project of the application.

DeploymentSource

Source template information for the deployment.

JSON representation 
{

  // Union field source can be only one of the following:
  "applicationTemplateRevision": string,
  "sharedTemplateRevisionUri": string
  // End of list of possible types for union field source.
}
Fields
Union field source. The source for the IaC deployment. source can be only one of the following:
applicationTemplateRevision

string

Application template revision URI.
sharedTemplateRevisionUri

string

Shared template revision URI.

ComponentParameters

Information about the component level parameters for an application.

JSON representation 
{
  "component": string,
  "parameters": [
    {
      object (Parameter)
    }
  ],
  "connectionsParameters": [
    {
      object (ConnectionParameters)
    }
  ]
}
Fields
component

string

Required. The name of the component parameter.
parameters[]

object (Parameter)

Optional. A list of parameters associated with the component.
connectionsParameters[]

object (ConnectionParameters)

Optional. A list of connections associated with the component.

ConnectionParameters

Connection level parameters associated with each component within an application.

JSON representation 
{
  "connection": string,
  "parameters": [
    {
      object (Parameter)
    }
  ]
}
Fields
connection

string

Required. The name of the connection parameter.
parameters[]

object (Parameter)

Optional. A list of parameters associated with the connection.

State

Possible values for the application deployment state.

Enums
STATE_UNSPECIFIED Unspecified application deployment state.
DRAFT Application is in draft.
CREATING_DEPLOYMENT New application deployment is in progress.
UPDATING_DEPLOYMENT Update application deployment is in progress.
DELETING Delete appication deployment is in progress.
DEPLOYED Appication deployment is completed.
DELETED Appication deployment is deleted.
FAILED Appication deployment is failed.
DEPLOYING Application deployment is in progress.

DeploymentMetadata

Deployment information for the application.

JSON representation 
{
  "revision": string,
  "componentOutputParameters": [
    {
      object (ComponentOutputParameters)
    }
  ],
  "error": {
    object (DeploymentError)
  },
  "build": string
}
Fields
revision

string

Output only. The revision of the deployment associated with the Application.
componentOutputParameters[]

object (ComponentOutputParameters)

Output only. The component output parameters of the deployment.
error

object (DeploymentError)

Output only. The error associated with the deployment.
build

string

Output only. Cloud Build instance UUID associated with this deployment.

ComponentOutputParameters

The component output parameters of the deployment.

JSON representation 
{
  "component": string,
  "parameters": [
    {
      object (Parameter)
    }
  ]
}
Fields
component

string

Output only. The component name of the output parameters.
parameters[]

object (Parameter)

Output only. The output parameters of the component.

DeploymentError

The error associated with the deployment.

JSON representation 
{
  "type": enum (ErrorType),
  "code": enum (ErrorCode),
  "tfErrors": [
    {
      object (TerraformError)
    }
  ],
  "detail": string,
  "deploymentFailureResolutionInfo": [
    {
      object (DeploymentFailureResolutionInfo)
    }
  ]
}
Fields
type

enum (ErrorType)

Output only. The error type based on the deployment error code.
code

enum (ErrorCode)

Output only. The deployment error code. Based on Infrastructure Manager error codes.
tfErrors[]

object (TerraformError)

Output only. The error message associated with the deployment.
detail

string

Output only. Human readable string that summarizes the deployment error issue.
deploymentFailureResolutionInfo[]

object (DeploymentFailureResolutionInfo)

Output only. The call to actions associated with the deployment issue.

ErrorType

Possible values for the deployment error types. This categorization is based on the error code returned by Infrastructure Manager.

Enums
ERROR_TYPE_UNSPECIFIED Unspecified error type.
PERMISSION Permission related error.
QUOTA Quota related error.
ALREADY_EXISTS Resource already exists.
RESOURCE_UNAVAILABLE Resource is unavailable.
BILLING Billing related error.
GENERIC Generic error if error does not fall under any of the above.
TERRAFORM Terraform related error.
BAD_INPUT Bad input error.
PLATFORM Platform related error.
API_ENABLEMENT API enablement error.
BAD_REQUEST Bad request error.

ErrorCode

Possible errors that can occur with deployments.

Enums
ERROR_CODE_UNSPECIFIED No error code was specified.
REVISION_FAILED The revision failed. See Revision for more details.
CLOUD_BUILD_PERMISSION_DENIED Cloud Build failed due to a permission issue.
DELETE_BUILD_API_FAILED Cloud Build job associated with a deployment deletion could not be started.
DELETE_BUILD_RUN_FAILED Cloud Build job associated with a deployment deletion was started but failed.
BUCKET_CREATION_PERMISSION_DENIED Cloud Storage bucket creation failed due to a permission issue.
BUCKET_CREATION_FAILED Cloud Storage bucket creation failed due to an issue unrelated to permissions.

TerraformError

Errors encountered during actuation using Terraform

JSON representation 
{
  "resourceAddress": string,
  "httpResponseCode": integer,
  "errorDescription": string,
  "error": {
    object (Status)
  }
}
Fields
resourceAddress

string

Address of the resource associated with the error, e.g. google_compute_network.vpc_network.
httpResponseCode

integer

HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.
errorDescription

string

A human-readable error description.
error

object (Status)

Output only. Original error response from underlying Google API, if available.

DeploymentFailureResolutionInfo

The call to action associated with the deployment issue.

JSON representation 
{
  "resolutionLink": string,
  "resolutionMessage": string,
  "resolutionLinkText": string
}
Fields
resolutionMessage

string

Output only. Elaborative error resolution message.
resolutionLinkText

string

Output only. Call to action link text.

ProjectParameters

The ProjectParameters provides the parameters needed to deploy the application in the given project.

JSON representation 
{
  "projectId": string,
  "roles": [
    string
  ],
  "apis": [
    string
  ]
}
Fields
projectId

string

Output only. The project ID of the project.
roles[]

string

Output only. IAM roles required by the service account to deploy the application in given project.
apis[]

string

Output only. APIs required to be enabled to deploy the application, in the form of "*.googleapis.com".

UpdatedTemplateRevision

The updated template revision, which results in an outdated application.

JSON representation 
{
  "templateRevision": string,
  "createTime": string,
  "templateDisplayName": string
}
Fields
templateRevision

string

Output only. The details of the updated template revision.
createTime

string (Timestamp format)

Output only. The time when the template was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
templateDisplayName

string

Output only. The display name of the template. If the display name is not available, the template resource name is used.

Methods

create

 Creates an application.

delete

 Deletes an application.

deploy

 Deploys an application.

generate

 Generates Terraform files for an application.

get

 Gets details about an application.

list

 Lists applications in a given space.

patch

 Updates an application.

preview

 Previews deployment of an application.