Package google.cloud.designcenter.v1alpha

Index

DesignCenter

Service describing handlers for resources

CommitApplicationTemplate

rpc CommitApplicationTemplate(CommitApplicationTemplateRequest) returns (ApplicationTemplateRevision)

Commits an application template to create a new revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.update

For more information, see the IAM documentation.
CreateApplication

rpc CreateApplication(CreateApplicationRequest) returns (Application)

Creates an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.applications.create

For more information, see the IAM documentation.
CreateApplicationTemplate

rpc CreateApplicationTemplate(CreateApplicationTemplateRequest) returns (ApplicationTemplate)

Creates an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.applicationTemplates.create

For more information, see the IAM documentation.
CreateCatalog

rpc CreateCatalog(CreateCatalogRequest) returns (Catalog)

Creates a catalog.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogs.create

For more information, see the IAM documentation.
CreateCatalogTemplate

rpc CreateCatalogTemplate(CreateCatalogTemplateRequest) returns (CatalogTemplate)

Adds a template to a catalog.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogTemplates.create

For more information, see the IAM documentation.
CreateCatalogTemplateRevision

rpc CreateCatalogTemplateRevision(CreateCatalogTemplateRevisionRequest) returns (Operation)

Creates a template revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogTemplateRevisions.create

For more information, see the IAM documentation.
CreateComponent

rpc CreateComponent(CreateComponentRequest) returns (Component)

Creates a component.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.components.create

For more information, see the IAM documentation.
CreateConnection

rpc CreateConnection(CreateConnectionRequest) returns (Connection)

Creates a connection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.connections.create

For more information, see the IAM documentation.
CreateShare

rpc CreateShare(CreateShareRequest) returns (Operation)

Shares a catalog from one space to another space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permissions on the parent resource:

  • designcenter.catalogTemplateRevisions.get
  • designcenter.catalogTemplateRevisions.list
  • designcenter.catalogTemplates.get
  • designcenter.catalogTemplates.list
  • designcenter.shares.create

Requires the following IAM permission on the destinationSpace resource:

  • designcenter.spaces.update

For more information, see the IAM documentation.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

Creates a space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.spaces.create

For more information, see the IAM documentation.
DeleteApplication

rpc DeleteApplication(DeleteApplicationRequest) returns (Operation)

Deletes an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applications.delete

For more information, see the IAM documentation.
DeleteApplicationTemplate

rpc DeleteApplicationTemplate(DeleteApplicationTemplateRequest) returns (Empty)

Deletes an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.delete

For more information, see the IAM documentation.
DeleteApplicationTemplateRevision

rpc DeleteApplicationTemplateRevision(DeleteApplicationTemplateRevisionRequest) returns (Empty)

Deletes an application template revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplateRevisions.delete

For more information, see the IAM documentation.
DeleteCatalog

rpc DeleteCatalog(DeleteCatalogRequest) returns (Operation)

Deletes a catalog.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogs.delete

For more information, see the IAM documentation.
DeleteCatalogTemplate

rpc DeleteCatalogTemplate(DeleteCatalogTemplateRequest) returns (Operation)

Deletes a catalog template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogTemplates.delete

For more information, see the IAM documentation.
DeleteCatalogTemplateRevision

rpc DeleteCatalogTemplateRevision(DeleteCatalogTemplateRevisionRequest) returns (Operation)

Deletes a template revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogTemplateRevisions.delete

For more information, see the IAM documentation.
DeleteComponent

rpc DeleteComponent(DeleteComponentRequest) returns (Empty)

Deletes a component.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.components.delete

For more information, see the IAM documentation.
DeleteConnection

rpc DeleteConnection(DeleteConnectionRequest) returns (Empty)

Deletes a connection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.connections.delete

For more information, see the IAM documentation.
DeleteShare

rpc DeleteShare(DeleteShareRequest) returns (Operation)

Deletes a catalog share.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permissions on the name resource:

  • designcenter.shares.delete
  • designcenter.shares.get

For more information, see the IAM documentation.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

Deletes a space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.spaces.delete

For more information, see the IAM documentation.
DeployApplication

rpc DeployApplication(DeployApplicationRequest) returns (Operation)

Deploys an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applications.get

For more information, see the IAM documentation.
GenerateApplicationIaC

rpc GenerateApplicationIaC(GenerateApplicationIaCRequest) returns (GenerateApplicationIaCResponse)

Generates Terraform files for an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applications.get

For more information, see the IAM documentation.
GenerateApplicationTemplateIaC

rpc GenerateApplicationTemplateIaC(GenerateApplicationTemplateIaCRequest) returns (GenerateApplicationTemplateIaCResponse)

Generates Terraform files for an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.get

For more information, see the IAM documentation.
GetApplication

rpc GetApplication(GetApplicationRequest) returns (Application)

Gets details about an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applications.get

For more information, see the IAM documentation.
GetApplicationTemplate

rpc GetApplicationTemplate(GetApplicationTemplateRequest) returns (ApplicationTemplate)

Gets details about an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.get

For more information, see the IAM documentation.
GetApplicationTemplateRevision

rpc GetApplicationTemplateRevision(GetApplicationTemplateRevisionRequest) returns (ApplicationTemplateRevision)

Gets details about an application template revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplateRevisions.get

For more information, see the IAM documentation.
GetCatalog

rpc GetCatalog(GetCatalogRequest) returns (Catalog)

Gets details about a catalog.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogs.get

For more information, see the IAM documentation.
GetCatalogTemplate

rpc GetCatalogTemplate(GetCatalogTemplateRequest) returns (CatalogTemplate)

Gets a catalog template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogTemplates.get

For more information, see the IAM documentation.
GetCatalogTemplateRevision

rpc GetCatalogTemplateRevision(GetCatalogTemplateRevisionRequest) returns (CatalogTemplateRevision)

Gets details about a template revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogTemplateRevisions.get

For more information, see the IAM documentation.
GetComponent

rpc GetComponent(GetComponentRequest) returns (Component)

Gets details about a Component.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.components.get

For more information, see the IAM documentation.
GetConnection

rpc GetConnection(GetConnectionRequest) returns (Connection)

Gets details about a connection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.connections.get

For more information, see the IAM documentation.
GetShare

rpc GetShare(GetShareRequest) returns (Share)

Get catalog share object for the space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.shares.get

For more information, see the IAM documentation.
GetSharedTemplate

rpc GetSharedTemplate(GetSharedTemplateRequest) returns (SharedTemplate)

Gets details about a shared template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.sharedTemplates.get

For more information, see the IAM documentation.
GetSharedTemplateRevision

rpc GetSharedTemplateRevision(GetSharedTemplateRevisionRequest) returns (SharedTemplateRevision)

Gets details about a shared template revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.sharedTemplateRevisions.get

For more information, see the IAM documentation.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

Gets details about a space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.spaces.get

For more information, see the IAM documentation.
ImportApplicationTemplate

rpc ImportApplicationTemplate(ImportApplicationTemplateRequest) returns (ApplicationTemplate)

Imports to an existing application template from a given shared template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.update

For more information, see the IAM documentation.
InferConnections

rpc InferConnections(InferConnectionsRequest) returns (Operation)

Infers and suggests connections between components within a space. The generated connection information can be used in application templates and designs.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.spaces.get

For more information, see the IAM documentation.
ListApplicationTemplateRevisions

rpc ListApplicationTemplateRevisions(ListApplicationTemplateRevisionsRequest) returns (ListApplicationTemplateRevisionsResponse)

Lists application template revisions in a given application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.applicationTemplateRevisions.list

For more information, see the IAM documentation.
ListApplicationTemplates

rpc ListApplicationTemplates(ListApplicationTemplatesRequest) returns (ListApplicationTemplatesResponse)

Lists application templates in a given space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.applicationTemplates.list

For more information, see the IAM documentation.
ListApplications

rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse)

Lists applications in a given space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.applications.list

For more information, see the IAM documentation.
ListCatalogTemplateRevisions

rpc ListCatalogTemplateRevisions(ListCatalogTemplateRevisionsRequest) returns (ListCatalogTemplateRevisionsResponse)

Lists template revisions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogTemplateRevisions.list

For more information, see the IAM documentation.
ListCatalogTemplates

rpc ListCatalogTemplates(ListCatalogTemplatesRequest) returns (ListCatalogTemplatesResponse)

Lists catalog templates.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogTemplates.list

For more information, see the IAM documentation.
ListCatalogs

rpc ListCatalogs(ListCatalogsRequest) returns (ListCatalogsResponse)

Lists catalogs in a given space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.catalogs.list

For more information, see the IAM documentation.
ListComponents

rpc ListComponents(ListComponentsRequest) returns (ListComponentsResponse)

Lists components in an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.components.list

For more information, see the IAM documentation.
ListConnections

rpc ListConnections(ListConnectionsRequest) returns (ListConnectionsResponse)

Lists connections in an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.connections.list

For more information, see the IAM documentation.
ListSharedTemplateRevisions

rpc ListSharedTemplateRevisions(ListSharedTemplateRevisionsRequest) returns (ListSharedTemplateRevisionsResponse)

Lists shared template revisions in a given space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.sharedTemplateRevisions.list

For more information, see the IAM documentation.
ListSharedTemplates

rpc ListSharedTemplates(ListSharedTemplatesRequest) returns (ListSharedTemplatesResponse)

Lists shared templates in a given space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.sharedTemplates.list

For more information, see the IAM documentation.
ListShares

rpc ListShares(ListSharesRequest) returns (ListSharesResponse)

Lists catalog share objects for the space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.shares.list

For more information, see the IAM documentation.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

Lists spaces in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • designcenter.spaces.list

For more information, see the IAM documentation.
PreviewApplication

rpc PreviewApplication(PreviewApplicationRequest) returns (Operation)

Previews deployment of an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applications.get

For more information, see the IAM documentation.
SyncShare

rpc SyncShare(SyncShareRequest) returns (Operation)

Synchronizes a share and updates the destination workspace to reflect. reflect the most recent changes to the catalog.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.shares.get

For more information, see the IAM documentation.
UpdateApplication

rpc UpdateApplication(UpdateApplicationRequest) returns (Application)

Updates an application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applications.update

For more information, see the IAM documentation.
UpdateApplicationTemplate

rpc UpdateApplicationTemplate(UpdateApplicationTemplateRequest) returns (ApplicationTemplate)

Updates an application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.update

For more information, see the IAM documentation.
UpdateCatalog

rpc UpdateCatalog(UpdateCatalogRequest) returns (Catalog)

Updates a catalog.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogs.update

For more information, see the IAM documentation.
UpdateCatalogTemplate

rpc UpdateCatalogTemplate(UpdateCatalogTemplateRequest) returns (CatalogTemplate)

Updates a catalog template resource.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.catalogTemplates.update

For more information, see the IAM documentation.
UpdateComponent

rpc UpdateComponent(UpdateComponentRequest) returns (Component)

Updates a component.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.components.update

For more information, see the IAM documentation.
UpdateConnection

rpc UpdateConnection(UpdateConnectionRequest) returns (Connection)

Updates a connection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.connections.update

For more information, see the IAM documentation.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

Updates a space.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.spaces.update

For more information, see the IAM documentation.

DesignCenterInternal

DesignCenterInternal is a service that is used to host private APIs.

ImportSerializedApplicationTemplate

rpc ImportSerializedApplicationTemplate(ImportSerializedApplicationTemplateRequest) returns (ApplicationTemplate)

Imports a serialized application template.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • designcenter.applicationTemplates.update

For more information, see the IAM documentation.

AlternateDefault

Alternate default for a UI input.

Fields
type

DisplayVariableAlternateType

Output only. Type of alternate default.
value

Value

Output only. Value of the alternate default.

AppHubApplicationParameters

App Hub application parameters.

Fields
application_id

string

Optional. The App Hub application ID.
scope

Scope

Optional. The App Hub application scope.
attributes

Attributes

Optional. The App Hub application attributes.
location

string

Optional. The App Hub application location. Only used for applications with REGIONAL scope.
host_project_id

string

Optional. The host project ID where the App Hub application is created.

Application

Represents the application resource.

Fields
name

string

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

Timestamp

Output only. Create timestamp.
update_time

Timestamp

Output only. Update timestamp.
source

DeploymentSource

Required. The application deployment source.
app_parameters[]

Parameter

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

ComponentParameters

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

string

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

string

Optional. Display name of the application.
description

string

Optional. Description of the application.
attributes

Attributes

Optional. Attributes of the application.
scope

Scope

Optional. Scope of the application.
import_existing_resources

bool

Optional. Import existing resources into the application.
preview_reference

string

Output only. Preview reference for the application.
deployment_revision

string

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

string

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

SerializedApplicationTemplate

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

State

Output only. Deployment state of the application.
deployment_metadata

DeploymentMetadata

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

ProjectParameters

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

string

Optional. The region where the application is deployed.
updated_template_revision

UpdatedTemplateRevision

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

string

Optional. Deployment project of the application.
connection_configs[]

ConnectionConfig

Optional. Connection configuration for the application.
artifact_location

ArtifactLocation

Output only. Details of the location where the IaC for this Application was last successfully exported.

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 application deployment is in progress.
DEPLOYED Application deployment is completed.
DELETED Application deployment is deleted.
FAILED Application deployment is failed.
DEPLOYING Application deployment is in progress.

ApplicationOperationMetadata

Ephemeral metadata depicting the state of the delete operation.

Fields
step

string

Output only. The current step of the delete operation. Associated with Infrastructure Manager and App Hub.
build

string

Output only. Cloud Build instance UUID associated with the delete operation.

ApplicationOutputParameters

The application output parameters of the deployment.

Fields
Union field parameters. The output parameters of the application. parameters can be only one of the following:
helm_application_output_parameters

HelmApplicationOutputParameters

Output only. Helm application output parameters.

ApplicationTemplate

Application template resource.

Fields
name

string

Identifier. Application template name.
display_name

string

Optional. Application template display name.
description

string

Optional. Application template description.
create_time

Timestamp

Output only. Application template creation timestamp.
update_time

Timestamp

Output only. Application template update timestamp.
application_parameters[]

Parameter

Optional. Parameters to apply to all components in an application. You can specify projectID and region.
iac_format

IACFormat

Output only. The IaC format of the application template.
serialized_application_template

SerializedApplicationTemplate

Output only. The serialized application template.
latest_revision

string

Output only. The latest application template revision.
artifact_location

ArtifactLocation

Output only. Details of the location where the IaC for this ApplicationTemplate was last successfully exported.

IACFormat

The IaC format of the application template.

Enums
IAC_FORMAT_UNSPECIFIED IaC format is unspecified.
TERRAFORM IaC format is Terraform.
HELM IaC format is Helm.

ApplicationTemplateRevision

Application template revision resource.

Fields
name

string

Identifier. The application template revision name.
create_time

Timestamp

Output only. The application template revision creation timestamp.
snapshot

SerializedApplicationTemplate

Output only. The serialized application template.

ArtifactLocation

Defines the location for storing an artifact, such as generated IaC.

Fields
Union field location. Specifies the type of destination for the artifact. location can be only one of the following:
developer_connect_export_config

DeveloperConnectExportConfig

Optional. Source Code Management(SCM) config for storing the content, such as generated IaC. Supports sources integrated with Developer Connect like GitHub, GitHub Enterprise, GitLab, and Bitbucket.
gcs_uri

string

Optional. The Cloud Storage URI for storing the generated IaC.

Catalog

A collection of templates.

Fields
name

string

Identifier. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog
display_name

string

Optional. The catalog display name.
description

string

Optional. The catalog description.
create_time

Timestamp

Output only. The catalog creation timestamp.
update_time

Timestamp

Output only. The catalog update timestamp.

CatalogTemplate

A template inside a catalog.

Fields
name

string

Identifier. The catalog template name in following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template
display_name

string

Optional. The display name of a catalog template.
description

string

Optional. The catalog template description.
uuid

string

Output only. The template revisions UUID.
create_time

Timestamp

Output only. The catalog template creation timestamp.
update_time

Timestamp

Output only. The catalog template update timestamp.
latest_revision_id

string

Output only. Latest revision of the template.
template_category

TemplateCategory

Optional. The category of the ADC template.
type

TemplateType

Optional. The Application Design Center assembly template type.

CatalogTemplateRevision

Template revisions inside a catalog.

Fields
name

string

Identifier. The catalog template revision name. projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template/revisions/$revision
description

string

Optional. The catalog template revision description.
type

TemplateType

Optional. The Application Design Center assembly template type.
create_time

Timestamp

Output only. The catalog template creation timestamp.
update_time

Timestamp

Output only. The catalog template update timestamp.
template_metadata

TFBlueprintMetadata

Output only. Template metadata related to Terraform input and output.
state

State

Output only. The template state (validating/ready/invalid).
application_template_revision

SerializedApplicationTemplate

Output only. The application template revision.
helm_chart_metadata

HelmChartMetadata

Output only. The helm chart metadata.
uuid

string

Output only. UUID of the template revision.
metadata_input

MetadataInput

Optional. Metadata input.
template_category

TemplateCategory

Output only. The category of the ADC template.
Union field artifact_location. The artifact location of the Terraform in the template. artifact_location can be only one of the following:
git_source

GitSource

Optional. The git source.
gcs_source_uri

string

Optional. The Cloud Storage URI, which must be in the format gs://[bucket] or gs://[bucket]/[object].
application_template_revision_source

string

Optional. The application template revision source.
developer_connect_source_config

DeveloperConnectSourceConfig

Optional. Configuration for fetching content from source code repository such as GitHub or Bitbucket through Developer Connect.
oci_repo

OciRepo

Optional. The Open Container Initiative (OCI) repo source that contains helm charts.

State

The template state.

Enums
STATE_UNSPECIFIED Default.
VALIDATING The template is being validated.
ACTIVE The template is ready to be used.
INVALID The template is invalid.

CommitApplicationTemplateRequest

Request message for CommitApplicationTemplate method.

Fields
name

string

Required. The name of the application template.

Component

Component resource.

Fields
name

string

Identifier. The component name.
shared_template_revision_uri

string

Required. The shared template used to generate the component.
parameters[]

Parameter

Optional. The component parameters.
create_time

Timestamp

Output only.

update_time

Timestamp

Output only. The component update timestamp.
roles[]

string

Output only. IAM roles required by the service account to deploy the component.
apis[]

string

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

string

Optional. The component display name.
connections_parameters[]

ConnectionParameters

Output only. The connection parameters of the component.
component_parameter_schema[]

ComponentParameterSchema

Output only. The component parameter schema, which includes possible parameter values. values.

ComponentOutputParameters

The component output parameters of the deployment.

Fields
component

string

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

Parameter

Output only. The output parameters of the component.

ComponentParameterSchema

Component parameter schema, which contains a list of all component parameters.

Fields
key

string

Output only. The key of the parameter.
default_value

Value

Output only. The default value of the parameter.
is_required

bool

Output only. Whether the parameter is required.
type

string

Output only. The type of the parameter.

ComponentParameters

Information about the component level parameters for an application.

Fields
component

string

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

Parameter

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

ConnectionParameters

Output only.

state

State

Output only. Deployment state of the component.
component_parameter_schema[]

ComponentParameterSchema

Output only. The component parameter schema, which includes possible parameter values.

State

Possible values of deployment state of the component.

Enums
STATE_UNSPECIFIED Unspecified component deployment state.
DRAFT Component is in draft.
CREATING_DEPLOYMENT New deployment is in progress.
UPDATING_DEPLOYMENT Update is in progress.
DELETING Deletion is in progress.
DEPLOYED Component deployment is completed.
DELETED Component deployment is deleted.
FAILED Component deployment is failed.

Connection

Connection resource.

Fields
name

string

Identifier. The connection name.
destination_component_uri

string

Required. The destination component URI used to generate the connection. Format is projects/$project/locations/$location/spaces/$space/applicationTemplates/$application_template/components/$component
create_time

Timestamp

Output only. The connection creation timestamp.
update_time

Timestamp

Output only. The connection update timestamp.
source_component_parameters[]

Parameter

Optional. The parameters of the connection associated with the source component.
destination_component_parameters[]

Parameter

Optional. The parameters of the connection associated with the destination component.

ConnectionConfig

Connection configuration for the application.

Fields
connection_uri

string

Required. The connection URI.
source_component_parameters[]

Parameter

Optional. The parameters of the connection associated with the source component.
destination_component_parameters[]

Parameter

Optional. The parameters of the connection associated with the destination component.

ConnectionParameters

Connection level parameters associated with each component within an application.

Fields
connection

string

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

Parameter

Optional. A list of parameters associated with the connection.

ConnectionSource

Defines the source of a connection.

Fields
source

string

Required. Source of the connection. Defined using the same format as module source of form [hostname]/namespace/name/provider for registry references and unprefixed github.com URLs for github references.
version

string

Required. Version constraint syntax using the same format as module version constraints.

ConnectionSpec

Defines the specifications of a connection.

Fields
output_expr

string

Required. Output expression identifying output being connected to variable.
input_path

string

Optional. Optional dot separated attribuite notation to connect to a specific object field of the input variable.

CreateApplicationRequest

Message for creating an application.

Fields
parent

string

Required. The parent resource in which to create the application. Format: projects/$project/locations/$location/spaces/$space
application_id

string

Required. The ID of the application to create.
application

Application

Required. The application to create.

CreateApplicationTemplateRequest

Message for creating an application template.

Fields
parent

string

Required. The parent resource in which to create the application template.
application_template_id

string

Required. The ID of the application template to create.
application_template

ApplicationTemplate

Required. The application template to create.

CreateCatalogRequest

Message for creating a catalog.

Fields
parent

string

Required. The parent space in which a catalog is created in the following format: projects/$project/locations/$location/spaces/$space
catalog_id

string

Required. The ID of the catalog to create.
catalog

Catalog

Required. The catalog to create.

CreateCatalogTemplateRequest

Message for creating a catalog template.

Fields
parent

string

Required. The parent resource in which the catalog template is created.
catalog_template_id

string

Required. The ID of the catalog template to create. The ID is appended to the catalog template's name.
catalog_template

CatalogTemplate

Required. The catalog template to create.

CreateCatalogTemplateRevisionRequest

Message for creating a template revisions request.

Fields
parent

string

Required. The parent in which the catalog template revisions request is created in following format: projects/$project/locations/$location/spaces/$space/templates/$template
catalog_template_revision_id

string

Required. The ID of the template revision to create.
catalog_template_revision

CatalogTemplateRevision

Required. The template revision to create.

CreateComponentRequest

Message for creating a component.

Fields
parent

string

Required. The parent resource in which to create the component.
component_id

string

Required. The ID of the component to create.
component

Component

Required. The component to create.

CreateConnectionRequest

Message for creating a connection.

Fields
parent

string

Required. The parent resource in which to create a connection.
connection_id

string

Required. The ID of the connection to create.
connection

Connection

Required. The connection to create.

CreateShareRequest

Message for creating a share of a catalog.

Fields
parent

string

Required. The parent resource in which shares are created.
share_id

string

Required. The ID of the share to create.
share

Share

Required. The share to create.

CreateSpaceRequest

Message for creating a space.

Fields
parent

string

Required. The parent in which to create a space.
space_id

string

Required. The ID of the space to create.
space

Space

Required. The space to create.

DeleteApplicationRequest

Message for deleting an application.

Fields
name

string

Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application
force

bool

Optional. If set to true, the application's children are also deleted. If false, the application is only deleted if it has no children.

DeleteApplicationTemplateRequest

Message for deleting an application template.

Fields
name

string

Required. The application template name.
force

bool

Optional. If set to true, the application template's children are also deleted. If false, the application template is only deleted if it has no children.

DeleteApplicationTemplateRevisionRequest

Message for deleting an application template revision.

Fields
name

string

Required. The application template revision name.

DeleteCatalogRequest

Message for deleting a catalog.

Fields
name

string

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog
force

bool

Optional. If set to true, the catalog's children are also deleted. If false, the catalog is only deleted if it has no children.

DeleteCatalogTemplateRequest

Message for deleting a catalog template.

Fields
name

string

Required. The catalog template name. Format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template
force

bool

Optional. If set to true, the catalog template's children are also deleted. If false, the catalog template is only deleted if it has no children.

DeleteCatalogTemplateRevisionRequest

Message for deleting a template revision.

Fields
name

string

Required. The template revision name.

DeleteComponentRequest

Message for deleting a component.

Fields
name

string

Required. The component name.
force

bool

Optional. If set to true, the component's children are also deleted. If false, the component is only deleted if it has no children.

DeleteConnectionRequest

Message for deleting a connection.

Fields
name

string

Required. The connection name.

DeleteShareRequest

Message for deleting a share of a catalog.

Fields
name

string

Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share

DeleteSpaceRequest

Message for deleting a space.

Fields
name

string

Required. The space name.
force

bool

Optional. If set to true, the space's children are also deleted. If false, the space is only deleted if it has no children.

DeployApplicationRequest

Message for deploying an application.

Fields
name

string

Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application
replace

bool

Optional. Flag to update the existing deployment. If not set or false, deploy will fail if application state is in the DEPLOYED state.
worker_pool

string

Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute, in the following format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this field is unspecified, the default Cloud Build worker pool will be used. If omitted and application resource ref provided has worker_pool defined, that worker pool is used.
service_account

string

Optional. The email address of the service account to use for this deployment.

  • If provided, this service account will be used to execute the deployment process, taking precedence over any service_account specified on the Application resource.
  • The caller must have the 'iam.serviceAccounts.actAs' permission on this service account.
  • If this field is omitted, the system will use the 'service_account' defined within the Application resource.
  • We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the deployment will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}

DeployApplicationResponse

Response for DeployApplication.

Fields
deployment

Deployment

Output only. Infrastructure Manager deployment.
build_id

string

Output only. Cloud Build deployment id.

DeploymentAttemptMetadata

DeploymentAttemptMetadata represents a previous deployment attempt for an operation that failed due to a retryable error.

Fields
attempt

int32

The sequential number of the attempt (starting from 1).
error_detail

string

Human readable string that summarizes the deployment error issue.
build

string

The build or execution ID associated with this specific attempt. This can be used to link back to logs or trace information.

DeploymentError

The error associated with the deployment.

Fields
type

ErrorType

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

ErrorCode

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

TerraformError

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

string

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

DeploymentFailureResolutionInfo

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

string

Output only. Stores errors generated by Infra Manager, as well as all non-internal errors (such as INVALID_ARGUMENT) that occur before initiating the deployment.

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.

DeploymentFailureResolutionInfo

The call to action associated with the deployment issue.

Fields
resolution_message

string

Output only. Elaborative error resolution message.
resolution_link_text

string

Output only. Call to action link text.

DeploymentMetadata

Deployment information for the application.

Fields
revision

string

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

ComponentOutputParameters

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

DeploymentError

Output only. The error associated with the deployment.
build

string

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

string

Output only. The user-specified Cloud Build worker pool resource used, which the system uses to deploy the application. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}.
retry_attempts

int32

Output only. The attempted number of deployment retries.
application_output_parameters

ApplicationOutputParameters

Output only. The application output parameters of the deployment.

DeploymentOperationMetadata

Ephemeral metadata depicting the state of the deployment operation.

Fields
deployment

string

Output only. The name of the deployment associated with the application.
deployment_step

string

Output only. The current step of the deployment. This will mimic the DeploymentStep enum in the deployment proto.
deployment_build

string

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

string

Output only. Location of the deployment operation logs in gs://{bucket}/{object} format.
resources[]

Resource

Details of the [Resources][]s in the deployment.
previous_attempt

DeploymentAttemptMetadata

Previous deployment attempt metadata.

DeploymentSource

Source template information for the deployment.

Fields
Union field source. The source for the IaC deployment. source can be only one of the following:
application_template_revision

string

Application template revision URI.
shared_template_revision_uri

string

Shared template revision URI.

DeveloperConnectConfig

This config defines the location of a source through Developer Connect.

Fields

DeveloperConnectExportConfig

Through Developer Connect, defines a location where content such as Infrastructure as Code (IaC) is stored.

Fields
developer_connect_repo_uri

string

Required. The Developer Connect Git repository link, formatted as projects/*/locations/*/connections/*/gitRepositoryLinks/*.
branch

string

Optional. The branch in repo to which the content such as Infrastructure as Code (IaC) should be written to. If empty, ADC will create a branch and push the changes.
dir

string

Required. Directory, relative to the source repo, where content such as Infrastructure as Code (IaC) will be stored. This must be a relative path.To specify the root directory, use '/'. If the path or any subdirectories do not exist, they will be created.
commit_sha

string

Output only. The SHA of the Git commit that contains the exported content such as Infrastructure as Code (IaC).

DeveloperConnectSourceConfig

This config specifies the location of a source (such as GitHub or Bitbucket) through Developer Connect.

Fields
developer_connect_repo_uri

string

Required. The Developer Connect Git repository link, formatted as projects/*/locations/*/connections/*/gitRepositoryLinks/*.
reference

GitReference

Required. The reference (for example, a branch, tag, or commit SHA) from which the content should be read.
dir

string

Required. The sub-directory within the repository from which to read content. The path must be relative to the repository's root such as dir1/dir2. To read content from the root dir, provide "/" as the value of the field.
fetched_commit_sha

string

Output only. The SHA of the commit deduced from GitReference.

DisplayVariable

Additional display specific Template pertaining to a particular input variable.

Fields
name

string

Required. The variable name from the corresponding standard Template file.
title

string

Required. Visible title for the variable on the UI. If not present, Name will be used for the Title.

DisplayVariableAlternateType

Alternate default value type. Allows you to define an alternative value for predefined use cases, such as security. If specified, this value can be used instead of the default value in BlueprintVariable.

Enums
DISPLAY_VARIABLE_ALTERNATE_TYPE_UNSPECIFIED Default
DISPLAY_VARIABLE_ALTERNATE_TYPE_SECURITY A more secure default.
DISPLAY_VARIABLE_ALTERNATE_TYPE_DC A default specifically needed for Application Design center.

DisplayVariableToggle

Display variable toggle.

Fields
variable

string

Output only. The name of the variable used to toggle the display of another variable.
variable_values[]

string

Output only. The value of the variable used to toggle the display of another variable.
variable_type

ToggleVariableType

Output only. The type of the variable used to toggle the display of another variable.

ToggleVariableType

Toogle variable type enum.

Enums
TOGGLE_VARIABLE_TYPE_UNSPECIFIED Default
TOGGLE_VARIABLE_TYPE_BOOLEAN Boolean
TOGGLE_VARIABLE_TYPE_STRING String
TOGGLE_VARIABLE_TYPE_INTEGER Integer

DisplayVariableVisibility

Visibility defines how the output is exposed.

Enums
DISPLAY_VARIABLE_VISIBILITY_UNSPECIFIED Default
DISPLAY_VARIABLE_VISIBILITY_ROOT Expose output as root module output.

GenerateApplicationIaCRequest

Request message for GenerateApplicationIaC method.

Fields
name

string

Required. The name of the application.
iac_format

IACFormat

Optional. The IaC format to generate.
gcs_uri
(deprecated)

string

Optional. The Cloud Storage URI to write the generated IaC to. DEPRECATED: Use the 'artifact_location' field instead.
artifact_location

ArtifactLocation

Optional. Specifies the destination for the generated IaC, which can be Cloud Storage or a Developer Connect repository.

GenerateApplicationIaCResponse

Response message for GenerateApplicationIaC method.

Fields
gcs_uri
(deprecated)

string

Output only. The Cloud Storage URI of the generated IaC. DEPRECATED: Use the 'artifact_location' field instead.
artifact_location

ArtifactLocation

Output only. The destination where the generated IaC was written.

GenerateApplicationTemplateIaCRequest

Request message for GenerateApplicationTemplateIaC method.

Fields
name

string

Required. The name of the application template.
iac_format

IACFormat

Optional. The IaC format to generate.
gcs_uri
(deprecated)

string

Optional. The Cloud Storage URI to write the generated IaC to. DEPRECATED: Use the 'artifact_location' field instead.
artifact_location

ArtifactLocation

Optional. Specifies the destination for the generated IaC, which can be Cloud Storage or a Developer Connect repository.

IACFormat

The IaC format to generate.

Enums
IAC_FORMAT_UNSPECIFIED IaC format is unspecified.
TERRAFORM IaC format is Terraform.
HELM IaC format is HELM.

GenerateApplicationTemplateIaCResponse

Response message for GenerateApplicationTemplateIaC method.

Fields
gcs_uri
(deprecated)

string

Output only. The Cloud Storage URI of the generated IaC. DEPRECATED: Use the 'artifact_location' field instead.
artifact_location

ArtifactLocation

Output only. The destination where the generated IaC was written.

GetApplicationRequest

Message for getting an application.

Fields
name

string

Required. The application name. Format: projects/$project/locations/$location/spaces/$space/applications/$application

GetApplicationTemplateRequest

Message for getting an application template.

Fields
name

string

Required. The application template name.

GetApplicationTemplateRevisionRequest

Message for getting an application template revision.

Fields
name

string

Required. The application template revision name.

GetCatalogRequest

Message for getting a catalog.

Fields
name

string

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

GetCatalogTemplateRequest

Message for getting a catalog template resource.

Fields
name

string

Required. The catalog template name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template

GetCatalogTemplateRevisionRequest

Message for GetTemplateRevision Request

Fields
name

string

Required. The catalog template revisions name.

GetComponentRequest

Message for getting a component.

Fields
name

string

Required. The component name.

GetConnectionRequest

Message for getting a connection.

Fields
name

string

Required. Name of the resource

GetShareRequest

Message for getting a share of a catalog.

Fields
name

string

Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share

GetSharedTemplateRequest

Message for getting a shared template.

Fields
name

string

Required. The shared template name. Format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate

GetSharedTemplateRevisionRequest

Message for getting a shared template revisions.

Fields
name

string

Required. The shared template revision name, in the following format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate/revisions/$revision

GetSpaceRequest

Results returned from projects.locations.spaces.get.

Fields
name

string

Required. The space name.

GitReference

The Git reference. Can be a commit SHA, branch name, or tag name.

Fields
Union field reference. The reference from which the content such as Infrastructure as Code (IaC) should be read. reference can be only one of the following:
branch

string

Optional. The name of the branch from which content should be read. For example: "main"
ref_tag

string

Optional. The reference tag from which content should be read. For example: "v1.2.3"
commit_sha

string

Optional. The full SHA hash of a specific commit from which content should be read.

GitSource

Defines how to access a Git source.

Fields
repo

string

Required. Location of the git repo to build.
dir

string

Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution.
commit_sha

string

Output only. The commit SHA of the git repo deduced from given ref_tag.
developer_connect_config
(deprecated)

DeveloperConnectConfig

Optional. This config defines the location of a source through Developer Connect. Used to access private git repos.
ref_tag

string

Required. The reference tag of the git repo.

HelmApplicationOutputParameters

The helm application output parameters of the deployment.

Fields
parameters[]

Parameter

Output only. The output parameters of the helm application.

HelmChartInput

Helm Chart inputs. Documentation: https://helm.sh/docs/

Fields
helm_input_variable

string

Output only. Input variable name present in Helm Chart values.yaml
description

string

Output only. Input variable description.
type

string

Output only. Input data type.
default_value

Value

Output only. The default value of the input variable.
is_required

bool

Output only. Indicates if input is required.
nested_inputs

map<string, HelmChartInput>

Output only. Contains details of nested inputs.

HelmChartMetadata

Helm Chart metadata.

Fields
helm_input[]

HelmChartInput

Output only. Helm Chart inputs.
helm_output[]

HelmChartOutput

Output only. Helm Chart outputs.

HelmChartOutput

Helm Chart outputs.

Fields
value

Value

Output only. Type of output.
helm_output_variable

string

Output only. Output variable name present.
description

string

Output only. Description of the variable.

IACFormat

The IaC format to generate.

Enums
IAC_FORMAT_UNSPECIFIED IaC format is unspecified.
TERRAFORM IaC format is Terraform.
HELM IaC format is HELM.

IacFormatInfo

IacFormatInfo defines the actuation tool used to provision the Template.

Fields
flavor

string

Required. Flavor is the type of the actuation tool.
version

string

Required. Required version for the actuation tool. required_version = ">= 0.13"

ImportApplicationTemplateRequest

Request message for ImportApplicationTemplate method.

Fields
name

string

Required. The name of the application template.
Union field source. The source for setting application template components/connections. source can be only one of the following:
application_template_revision_uri

string

Optional. The source URI for application template revision.
shared_template_revision_uri

string

Optional. The source URI for catalog template.

ImportSerializedApplicationTemplateRequest

Request message for ImportSerializedApplicationTemplate.

Fields
name

string

Required. The name of the application template.
serialized_application_template

SerializedApplicationTemplate

Required. The serialized application template to be imported.

InferConnectionsRequest

Request message for InferConnections method.

Fields
name

string

Required. The name of the space.
catalog_template_revision_ids[]

string

Optional. A list of components that you want to infer connections for. If you don't provide this, the system infers connections for all components in the space, including all catalogs.
use_gemini

bool

Optional. Whether to use Gemini.

InferConnectionsResponse

Response message for InferConnections method.

Fields
catalog_template_revisions[]

CatalogTemplateRevision

List of components containing inferred connections.

ListApplicationTemplateRevisionsRequest

Message for requesting a list of application template revisions.

Fields
parent

string

Required. The parent from which to list application template revisions.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which application template revisions to return.
order_by

string

Optional. How the results should be sorted.

ListApplicationTemplateRevisionsResponse

Message for response to listing application template revisions.

Fields
application_template_revisions[]

ApplicationTemplateRevision

The list of application template revisions.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

ListApplicationTemplatesRequest

Message for requesting a list of application templates.

Fields
parent

string

Required. The parent resource from which to list application templates.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which shared template revisions to return.
order_by

string

Optional. How the results should be sorted.

ListApplicationTemplatesResponse

Message for response to listing application templates.

Fields
application_templates[]

ApplicationTemplate

The list of application templates.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

ListApplicationsRequest

Message for requesting a list of applications.

Fields
parent

string

Required. The parent resource from which to request a list of applications.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which applications to return.
order_by

string

Optional. How the results should be sorted.

ListApplicationsResponse

Message for response to listing applications.

Fields
applications[]

Application

The list of applications.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

ListCatalogTemplateRevisionsRequest

Message for requesting list of template revisions.

Fields
parent

string

Required. The parent resource from which a list of catalog template revisions is requested.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which catalog template revisions to return.
order_by

string

Optional. How the results should be sorted.

ListCatalogTemplateRevisionsResponse

Message for response to listing template revisions.

Fields
catalog_template_revisions[]

CatalogTemplateRevision

The list of template revisions.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

ListCatalogTemplatesRequest

Message for requesting a list of catalog templates.

Fields
parent

string

Required. The parent from which the catalog templates are listed in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses the catalog templates to return.
order_by

string

Optional. How the results should be sorted.

ListCatalogTemplatesResponse

Message for response to listing catalog templates.

Fields
catalog_templates[]

CatalogTemplate

The list of catalog templates.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

ListCatalogsRequest

Message for requesting a list of catalogs.

Fields
parent

string

Required. The parent space from which catalogs are listed. Format: projects/$project/locations/$location/spaces/$space
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which catalogs to return.
order_by

string

Optional. How the results should be sorted.

ListCatalogsResponse

Results returned from catalogs.list.

Fields
catalogs[]

Catalog

A list of catalogs
next_page_token

string

If there might be more results than those appearing in this response, nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

ListComponentsRequest

Message for requesting a list of components.

Fields
parent

string

Required. The parent resource from which the list of components is requested.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which components to return.
order_by

string

Optional. How the results should be sorted.

ListComponentsResponse

Message for response to listing components.

Fields
components[]

Component

The list of components.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

ListConnectionsRequest

Message for requesting a list of connections.

Fields
parent

string

Required. The parent resource from which to request a list of connections.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which connections to return.
order_by

string

Optional. How the results should be sorted.

ListConnectionsResponse

Message for response to listing connections.

Fields
connections[]

Connection

The list of connections.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

ListSharedTemplateRevisionsRequest

Message for requesting a list of shared template revisions.

Fields
parent

string

Required. The parent resource from which to list shared template revisions, in the following format: projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which shared template revisions to return.
order_by

string

Optional. How the results should be sorted.

ListSharedTemplateRevisionsResponse

Message for response to listing shared templates.

Fields
shared_template_revisions[]

SharedTemplateRevision

The list of shared templates.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

ListSharedTemplatesRequest

Message for requesting list of shared templates.

Fields
parent

string

Required. The parent space for which shared templates are listed in the following format: projects/$project/locations/$location/spaces/$space
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which shared templates to return.
order_by

string

Optional. How the results should be sorted.

ListSharedTemplatesResponse

Message for response to listing shared templates.

Fields
shared_templates[]

SharedTemplate

The list of shared templates.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

ListSharesRequest

Message for listing shares of a catalog.

Fields
parent

string

Required. The parent resource from which a list of shares is requested.
page_size

int32

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
order_by

string

Optional. How the results should be sorted.

ListSharesResponse

Message for response to listing shares of a catalog.

Fields
shares[]

Share

The list of shares.
next_page_token

string

If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.

ListSpacesRequest

Message for requesting a list of spaces.

Fields
parent

string

Required. The name of the parent resource, for which spaces are listed.
page_size

int32

Optional. The maximum number of pages to return from this request. If unspecified, the value automatically reflects the number of results returned.
page_token

string

Optional. If present, retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
filter

string

Optional. A filter that chooses which spaces to return.
order_by

string

Optional. How the results are sorted.

ListSpacesResponse

Results returned from projects.locations.spaces.list.

Fields
spaces[]

Space

A list of spaces.
next_page_token

string

If there might be more results than those appearing in this response, nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
unreachable[]

string

Locations that could not be reached.

MetadataInput

Metadata for the input

Fields
spec

MetadataInputSpec

Required. spec containing the metadata

MetadataInputSpec

Specifications for the input

Fields
info

TemplateInfo

Optional. TemplateInfo provides the actuation tool information.
interfaces

TemplateSchema

Optional. TemplateSchemas provides the input variables lists and connection information.
requirements

TemplateRequirements

Required. TemplateRequirements defines the roles required and the provider versions.
ui

TemplateUi

Optional. TemplateUi defines the UI related information for the Template.

OciRepo

Open Container Initiative (OCI) repo.

Fields
uri

string

Required. Path to Open Container Initiative (OCI) repo. Example: oci://us-west1-docker.pkg.dev/nyap-test/helm-repo/my-chart
version

string

Optional. The version of the helm chart.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. The server defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.
Union field resource_metadata. Metadata about the state of an operation for a particular resource. resource_metadata can be only one of the following:
deployment_metadata

DeploymentOperationMetadata

Output only. The application deployment metadata this operation is associated with.
preview_metadata

PreviewOperationMetadata

Output only. The application preview metadata this operation is associated with.
application_metadata

ApplicationOperationMetadata

Output only. The application delete metadata this operation is associated with.

Parameter

Parameter resource.

Fields
key

string

Required. The key of the parameter.
value

Value

Required. The value of the parameter.

PreviewApplicationRequest

Message for deploying an application.

Fields
name

string

Required. The application name in the following format: projects/$project/locations/$location/spaces/$space/applications/$application
worker_pool

string

Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format projects/{project}/locations/{location}/workerPools/{workerPoolId} If this field is unspecified, the default Cloud Build worker pool will be used. If omitted and application resource ref provided has worker_pool defined, that worker pool is used.
service_account

string

Optional. The email address of the service account to use for this preview operation.

  • If provided, this service account will be used to execute the preview process, taking precedence over any service_account specified on the Application resource.
  • The caller must have the 'iam.serviceAccounts.actAs' permission on this service account.
  • If this field is omitted, the system will use the 'service_account' defined within the Application resource.
  • We recommend that you provide a service account here or on the Application resource. If you don't provide a service account, the preview will fail. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS}

PreviewApplicationResponse

Response for PreviewApplication.

Fields
preview

Preview

Output only. Infrastructure Manager preview.

PreviewOperationMetadata

Ephemeral metadata depicting the state of the preview operation.

Fields
preview_step

string

Output only. The current step of the preview. The possible steps a preview may be running as returned by the Infrastructure. Manager.
preview_build

string

Output only. Cloud Build instance UUID associated with the preview operation.
preview_logs

string

Output only. Location of the preview operation logs in gs://{bucket}/{object} format.
resources[]

Resource

Details of the [Resources][]s in the deployment.

ProjectParameters

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

Fields
project_id

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

ProviderVersion

ProviderVersion defines the required version for a provider.

Fields
source

string

Output only. The provider source in the format: [hostname]/[namespace]/[name]. Hostname is optional, and defaults to the Terraform registry.
version

string

Output only. Version constraint string.

Resource

Status of the [Resources][]s in the deployment.

Fields
name

string

Output only. Identifier. The name of the resource.
type

string

Output only. The type of the resource.
state

State

Output only. Current state of the resource.

State

Possible states of a resource.

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
PLANNED Resource has been planned for reconcile.
IN_PROGRESS Resource is actively reconciling into the intended state.
RECONCILED Resource has reconciled to intended state.
FAILED Resource failed to reconcile.
DRIFTED Drift is detected in the resourece state.
INTENDED Resource is intended state.

SerializedApplicationTemplate

Serialized application template.

Fields
uri

string

Optional. The application template URI.
display_name

string

Optional. The application template display name.
description

string

Optional. The application template description.
application_parameters[]

Parameter

Optional. Parameters to apply to all components in the application template.
iac_format

IACFormat

Optional. The IaC format of the application template.
components[]

SerializedComponent

Optional. The application template components.
apphub_application_parameters

AppHubApplicationParameters

Optional. The App Hub application parameters.
has_global_resource

bool

Output only. Whether the application template is compatible with regional scope.

SerializedComponent

Serialized component.

Fields
uri

string

Optional. The component URI.
shared_template_revision_uri

string

Optional. The shared template used to generate the component.
parameters[]

Parameter

Optional. The component parameters.
connections[]

SerializedConnection

Optional. The component connections.
roles[]

string

Optional. IAM roles required by the service account to deploy the component.
apis[]

string

Optional. APIs required to be enabled to deploy the component, in the form of "*.googleapis.com".
display_name

string

Optional. The component display name.
connections_parameters[]

ConnectionParameters

Output only. The connection parameters of the component.
component_parameter_schema[]

ComponentParameterSchema

Output only. The component parameter schema, which includes possible parameter values.

SerializedConnection

Serialized connection.

Fields
uri

string

Optional. The connection URI.
destination_component_uri

string

Optional. The destination component URI used to generate the connection.
source_component_parameters[]

Parameter

Optional. The parameters of the connection associated with the source component.
destination_component_parameters[]

Parameter

Optional. The parameters of the connection associated with the destination component.

Share

A catalog share between spaces.

Fields
name

string

Identifier. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share
destination_space

string

Required. The space resource path to which the catalog is shared. Format is projects/$project/locations/$location/spaces/$space
create_time

Timestamp

Output only. The share creation timestamp.
state

State

Output only. The state of the share.

State

The share status, which indicates whether the catalog is in sync.

Enums
STATE_UNSPECIFIED The state of the share is unknown.
IN_SYNC The share is in sync with the shared template catalog.
OUT_OF_SYNC The share is out of sync with the shared template catalog.

SharedTemplate

A read-only template that is shared with a space.

Fields
name

string

Identifier. The shared template name. projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate
display_name

string

Optional. The shared template display name.
description

string

Optional. The shared template description.
origin_template

string

Output only. The origin template of the shared template.
create_time

Timestamp

Output only. The shared template creation timestamp.
update_time

Timestamp

Output only. The shared template update timestamp.
latest_revision_id

string

Output only. Latest revision of the shared template.
template_category

TemplateCategory

Optional. The category of the ADC template.
type

TemplateType

Optional. The Application Design Center assembly template type.

SharedTemplateRevision

A read-only template revision that is shared with a space.

Fields
name

string

Identifier. The shared template revision name. $sharedTemplate is a server-generated UUID. projects/$project/locations/$location/spaces/$space/sharedTemplates/$sharedTemplate/revisions/$revision
description

string

Optional. The shared template revision description.
type

TemplateType

Optional. The Application Design Center assembly template type.
shared_template_metadata

TFBlueprintMetadata

Output only. The shared template metadata.
origin_template_revision

string

Output only. The shared template revision refers to the following catalog template revision.
create_time

Timestamp

Output only. The shared template revision creation timestamp.
application_template_revision

SerializedApplicationTemplate

Output only. The serialized application template revision.
helm_chart_metadata

HelmChartMetadata

Output only. The helm chart metadata.
template_category

TemplateCategory

Output only. The category of the ADC template.
Union field artifact_location. The artifact location of the Terraform in the template. artifact_location can be only one of the following:
git_source

GitSource

Optional. The git source.
gcs_source_uri

string

Optional. The Cloud Storage URI, which must be in the format gs://[bucket] or gs://[bucket]/[object].
application_template_revision_source

string

Optional. The application template revision source.
developer_connect_source_config

DeveloperConnectSourceConfig

Optional. Configuration for fetching content from source code repository such as GitHub or Bitbucket through Developer Connect.
oci_repo

OciRepo

Optional. The Open Container Initiative (OCI) repo source that contains helm charts.

Space

Space is a top level resource for managing teams building applications through Application Design Center.

Fields
name

string

Identifier. The space name.
display_name

string

Optional. Display name for the space.
description

string

Optional. Description for the space.
create_time

Timestamp

Output only. Space creation timestamp.
update_time

Timestamp

Output only. Space update timestamp
gcs_bucket

string

Optional. An existing Google Cloud Storage bucket that you want to use instead of creating a new bucket during ADC setup. If not provided, a default bucket is created during setup. The bucket must exist in the same project as the space. If the bucket name does not exist in the same project as the space, the request fails with an INVALID_ARGUMENT error. If you do not have access to the bucket, the request fails with a PERMISSION_DENIED error. Format: {$bucket_name} For example, if the Cloud Storage bucket URI is gs:\/\/{$bucket_name}, the format is {$bucket_name}.
enable_gcp_shared_templates

bool

Optional. Flag to enable Google opinionated shared templates.

SyncShareRequest

Message for syncing a share of a catalog.

Fields
name

string

Required. The share name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/shares/$share

TFBlueprintMetadata

Terraform input and output metadata.

Fields
terraform_input[]

TerraformInput

Output only. Terraform inputs.
terraform_output[]

TerraformOutput

Output only. Terraform outputs.
apis[]

string

Output only. APIs that must be enabled to deploy the template, in the form of "compute.googleapis.com".
roles[]

string

Output only. IAM roles required by the service account deploying the template, in the form of "roles/compute.admin".
deployment_duration

Duration

Optional. The time estimate for deploying the blueprint.
icon_uri

string

Output only. The icon URI for the blueprint.
connections[]

TerraformInputConnections

Output only. TODO b/358313147 - Check if connection field is required here. Union of all the Terraform input connections.
ui_metadata

TerraformBlueprintUiMetadata

Output only. UI metadata for the blueprint.
provider_versions[]

ProviderVersion

Output only. Provider versions required to deploy the blueprint.

TemplateCategory

Supported categories in ADC

Enums
TEMPLATE_CATEGORY_UNSPECIFIED Unspecified category.
COMPONENT_TEMPLATE ADC component.
APPLICATION_TEMPLATE ADC application.
COMPOSITE_SOLUTION_TEMPLATE Imported as a single, complex unit without disassembling into components.

TemplateConnections

TemplateConnections

Fields
source

ConnectionSource

Required. Source of the connection.
spec

ConnectionSpec

Required. Connection specifications.

TemplateInfo

TemplateInfo provides the actuation tool information.

Fields
actuation_tool

IacFormatInfo

Required. IaCFormatInfo defines the actuation tool used to provision the Template.

TemplateRequirements

TemplateRequirements defines the roles required and the associated services that need to be enabled to provision Template resources.

Fields
roles[]

TemplateRoles

Required. All roles required for the component
provider_versions[]

ProviderVersion

Required. Required provider versions.

TemplateRoles

Template Roles provide the level and roles

Fields
level

string

Required. Level of the role.
roles[]

string

Required. List of roles.

TemplateSchema

TemplateSchema provides the input variables lists and connection information.

Fields
variables[]

TemplateVariable

Required. All defined variables for the Template

TemplateType

Assembly template types.

Enums
TEMPLATE_TYPE_UNSPECIFIED Default.
SERVICE A service template is an App Hub service.
WORKLOAD A workload template is an App Hub workload.
ASSET An asset template can be used to provision resources that are not services or workloads.
APPLICATION An application template is a composition of workload/service/asset templates.
JSS_SOLUTION A Jumpstart Solution template.
SERVICE_DATA_SOURCE A service data source template.
HELM_APPLICATION A helm chart based template.

TemplateUi

TemplateUi defines the UI related information for the Template.

Fields
input

TemplateUiInput

Required. The top-level input section that defines the list of variables and their sections on the deployment page.

TemplateUiInput

TemplateUiInput defines the list of variables and their sections on the deployment page.

Fields
variables

map<string, DisplayVariable>

Required. variables is a map defining all inputs on the UI.

TemplateVariable

TemplateTerraform inputs.

Fields
name

string

Required. Input variable name present in Terraform.
connections[]

TemplateConnections

Required. Terraform input connections.

TerraformBlueprintUiMetadata

Terraform blueprint UI metadata.

Fields
terraform_ui_input

TerraformUiInput

Output only. Terraform UI inputs.
terraform_ui_output

TerraformUiOutput

Output only. Terraform UI outputs.

TerraformInput

Terraform inputs.

Fields
terraform_input_variable

string

Output only. Input variable name present in Terraform.
description

string

Output only. Terraform variable description.
type

string

Output only. The Terraform input data type.
default_value

Value

Output only. The default value of the Terraform input variable.
connections[]

TerraformInputConnections

Output only. Terraform input connections.
is_required

bool

Output only. Indicates if input is required.

TerraformInputConnections

TerraformInputConnections

Fields
cft_template_uri

string

Output only. List of other templates that can be connected to.
cft_template_version

string

Output only. Version of the other template that can be connected to.
output_var

string

Output only. Output variable name present in Terraform.
input_path

string

Output only. Input path of the other template that can be connected to.

TerraformOutput

Terraform outputs.

Fields
type

Value

Output only. Type of Terraform output.
terraform_output_variable

string

Output only. Output variable name present in Terraform.
description

string

Output only. Description of the Terraform varaiable.

TerraformUiInput

Terraform blueprint UI input.

Fields
terraform_ui_inputs

map<string, TerraformUiInputDisplayVariable>

Output only. Terraform UI inputs.

TerraformUiInputDisplayVariable

Terraform blueprint UI input display variable.

Fields
display_name

string

Output only. Display name of the input.
title

string

Output only. Title of the input.
alternate_defaults[]

AlternateDefault

Output only. Alternate defaults for the input.
regex_validation

string

Output only. Regex based validation rules for the variable.
min

float

Output only. Minimum value for numeric types.
max

float

Output only. Maximum value for numeric types.
validation

string

Output only. Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters.
enum_value_labels[]

ValueLabel

Output only. Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters.
level

int32

Output only. Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation. Optional.
subtext

string

Output only. Property subtext, displayed below the title.
toggle_using_variables[]

DisplayVariableToggle

Output only. Variables used to toggle the display of another variable.
properties

map<string, TerraformUiInputDisplayVariable>

Output only. A map that defines all fields of the input variable.

TerraformUiOutput

Terraform blueprint UI output.

Fields
output_message

string

Output only. Message to be displayed in the UI.
terraform_ui_outputs

map<string, TerraformUiOutputDisplay>

Output only. Visibility of the output.

TerraformUiOutputDisplay

Terraform blueprint UI output display.

Fields
visibility

DisplayVariableVisibility

Output only. Visibility of the output.

UpdateApplicationRequest

Message for updating an application.

Fields
update_mask

FieldMask

Optional. The fields to overwrite in the application update. If you don't provide a mask, all fields are overwritten.
application

Application

Required. The application to update.

UpdateApplicationTemplateRequest

Message for updating an application template.

Fields
update_mask

FieldMask

Optional. The fields to overwrite in the application template update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.
application_template

ApplicationTemplate

Required. The application template to update.

UpdateCatalogRequest

Message for updating a catalog.

Fields
update_mask

FieldMask

Optional. The fields to overwrite in the catalog update. If you don't provide a mask, all fields are overwritten.
catalog

Catalog

Required. The catalog to update.

UpdateCatalogTemplateRequest

Message for updating a catalog template.

Fields
catalog_template

CatalogTemplate

Required. The catalog template to update. Format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog/templates/$template
update_mask

FieldMask

Optional. The fields to overwrite in the catalog template update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.

UpdateComponentRequest

Message for updating a component.

Fields
update_mask

FieldMask

Optional. The fields to overwrite in the component update. If you don't provide a mask, all fields are overwritten.
component

Component

Required. The component to update.

UpdateConnectionRequest

Message for updating a connection.

Fields
update_mask

FieldMask

Optional. Fields to overwrite in the connection update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If you don't provide a mask, all fields are overwritten.
connection

Connection

Required. The connection to update.

UpdateSpaceRequest

Message for updating a space.

Fields
update_mask

FieldMask

Optional. The fields to overwrite in the space update. If you don't provide a mask, all fields are overwritten.
space

Space

Required. The space to update.

UpdatedTemplateRevision

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

Fields
template_revision

string

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

Timestamp

Output only. The time when the template was created.
template_display_name

string

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

ValueLabel

Value label for a UI input.

Fields
value

string

Output only. Value of the enum.
label

string

Output only. Label of the enum.