Index
DesignCenter(interface)DesignCenterInternal(interface)AdcMetadata(message)AlternateDefault(message)AlternateDefaultInput(message)AppHubApplicationParameters(message)Application(message)Application.State(enum)Application.UpdateStrategy(enum)ApplicationCompositionType(enum)ApplicationOperation(enum)ApplicationOperationMetadata(message)ApplicationOperationResponse(message)ApplicationOperationResponse.OperationType(enum)ApplicationOutputParameters(message)ApplicationTemplate(message)ApplicationTemplate.IACFormat(enum)ApplicationTemplateOperation(enum)ApplicationTemplateRevision(message)ApplicationTemplateSystemRevision(message)ApplicationType(enum)ArtifactLocation(message)AssessBestPracticesRequest(message)AssessBestPracticesResponse(message)AssessBestPracticesResponse.AssessmentResult(message)AssessBestPracticesResponse.AssessmentResult.AssessmentFinding(message)AssessedFramework(message)AssessmentFinding(message)AssessmentFinding.FindingADCMetadata(message)AssessmentFinding.Severity(enum)AssessmentFinding.Type(enum)AssessmentReport(message)AssetDetails(message)Catalog(message)CatalogTemplate(message)CatalogTemplateRevision(message)CatalogTemplateRevision.State(enum)CloudControl(message)CloudControl.EnforcementMode(enum)CodePosition(message)CodeRange(message)CommitApplicationTemplateRequest(message)Component(message)ComponentApplicationInfo(message)ComponentOutputParameters(message)ComponentParameterSchema(message)ComponentParameters(message)ComponentParameters.State(enum)ComponentVariable(message)CompositeApplicationParameters(message)Connection(message)ConnectionConfig(message)ConnectionParameters(message)ConnectionSource(message)ConnectionSpec(message)CreateApplicationRequest(message)CreateApplicationTemplateRequest(message)CreateCatalogRequest(message)CreateCatalogTemplateRequest(message)CreateCatalogTemplateRevisionRequest(message)CreateComponentRequest(message)CreateConnectionRequest(message)CreatePolicyRequest(message)CreateShareRequest(message)CreateSpaceRequest(message)DeleteApplicationRequest(message)DeleteApplicationTemplateRequest(message)DeleteApplicationTemplateRevisionRequest(message)DeleteCatalogRequest(message)DeleteCatalogTemplateRequest(message)DeleteCatalogTemplateRevisionRequest(message)DeleteComponentRequest(message)DeleteConnectionRequest(message)DeletePolicyRequest(message)DeleteShareRequest(message)DeleteSpaceRequest(message)DeployApplicationRequest(message)DeployApplicationResponse(message)DeployedResource(message)DeployedResourceResponse(message)DeploymentAttemptMetadata(message)DeploymentError(message)DeploymentError.ErrorType(enum)DeploymentFailureResolutionInfo(message)DeploymentGroupMetadata(message)DeploymentMetadata(message)DeploymentOperationMetadata(message)DeploymentSource(message)DeploymentTarget(message)DeploymentUnitProgress(message)DeveloperConnectConfig(message)DeveloperConnectExportConfig(message)DeveloperConnectSourceConfig(message)DisplayVariable(message)DisplayVariableAlternateType(enum)DisplayVariableToggle(message)DisplayVariableToggle.ToggleVariableType(enum)DisplayVariableVisibility(enum)Domain(message)DomainAssessmentReport(message)DomainAssessmentReport.DomainRedirectInfo(message)DomainAssessmentReport.Status(enum)ExportApplicationTemplateIaCRequest(message)ExportApplicationTemplateIaCResponse(message)ExportApplicationTemplateRevisionIaCRequest(message)ExportApplicationTemplateRevisionIaCResponse(message)ExportIaCConfig(message)FetchApplicationAssessmentReportRequest(message)FetchApplicationAssessmentReportResponse(message)FetchApplicationRequest(message)FetchApplicationResponse(message)FetchCatalogTemplateRevisionTFSourceRequest(message)FetchCatalogTemplateRevisionTFSourceResponse(message)FetchFrameworksRequest(message)FetchFrameworksResponse(message)FetchSharedTemplateRevisionTFSourceRequest(message)FetchSharedTemplateRevisionTFSourceResponse(message)Framework(message)Framework.DeploymentStatus(enum)GKEDeploymentTarget(message)GenerateApplicationIaCRequest(message)GenerateApplicationIaCResponse(message)GenerateApplicationTemplateAssessmentReportRequest(message)GenerateApplicationTemplateAssessmentReportResponse(message)GenerateApplicationTemplateIaCRequest(message)GenerateApplicationTemplateIaCRequest.IACFormat(enum)GenerateApplicationTemplateIaCResponse(message)GenerateApplicationTemplateRevisionIaCRequest(message)GenerateApplicationTemplateRevisionIaCRequest.IACFormat(enum)GenerateApplicationTemplateRevisionIaCResponse(message)GenerateAssessmentReportRequest(message)GenerateAssessmentReportResponse(message)GetApplicationRequest(message)GetApplicationTemplateRequest(message)GetApplicationTemplateRevisionRequest(message)GetApplicationTemplateSystemRevisionRequest(message)GetCatalogRequest(message)GetCatalogTemplateRequest(message)GetCatalogTemplateRevisionRequest(message)GetComponentRequest(message)GetConnectionRequest(message)GetPolicyRequest(message)GetShareRequest(message)GetSharedTemplateRequest(message)GetSharedTemplateRevisionRequest(message)GetSpaceRequest(message)GitReference(message)GitSource(message)HelmApplicationOutputParameters(message)HelmChartInput(message)HelmChartMetadata(message)HelmChartOutput(message)IACFormat(enum)IaCFile(message)IaCModule(message)IacFormatInfo(message)ImportApplicationIaCRequest(message)ImportApplicationIaCResponse(message)ImportApplicationIaCResponse.State(enum)ImportApplicationTemplateIaCRequest(message)ImportApplicationTemplateIaCResponse(message)ImportApplicationTemplateIaCResponse.State(enum)ImportApplicationTemplateRequest(message)ImportIaCError(message)ImportIaCError.Type(enum)ImportSerializedApplicationTemplateRequest(message)InferConnectionsRequest(message)InferConnectionsResponse(message)InferredMetadata(message)ListApplicationTemplateRevisionsRequest(message)ListApplicationTemplateRevisionsResponse(message)ListApplicationTemplateSystemRevisionsRequest(message)ListApplicationTemplateSystemRevisionsResponse(message)ListApplicationTemplatesRequest(message)ListApplicationTemplatesResponse(message)ListApplicationsRequest(message)ListApplicationsResponse(message)ListCatalogTemplateRevisionsRequest(message)ListCatalogTemplateRevisionsResponse(message)ListCatalogTemplatesRequest(message)ListCatalogTemplatesResponse(message)ListCatalogsRequest(message)ListCatalogsResponse(message)ListComponentsRequest(message)ListComponentsResponse(message)ListConnectionsRequest(message)ListConnectionsResponse(message)ListPoliciesRequest(message)ListPoliciesResponse(message)ListSharedTemplateRevisionsRequest(message)ListSharedTemplateRevisionsResponse(message)ListSharedTemplatesRequest(message)ListSharedTemplatesResponse(message)ListSharesRequest(message)ListSharesResponse(message)ListSpacesRequest(message)ListSpacesResponse(message)LogicalProduct(message)ManageApplicationRequest(message)ManageApplicationResponse(message)ManageApplicationTemplateRequest(message)ManageApplicationTemplateResponse(message)MetadataInput(message)MetadataInputSpec(message)OciRepo(message)OperationMetadata(message)Parameter(message)Policy(message)Policy.ApplyCondition(message)Policy.PolicyType(enum)PreviewApplicationRequest(message)PreviewApplicationResponse(message)PreviewOperationMetadata(message)ProjectParameters(message)ProjectParametersList(message)ProviderVersion(message)ProvisionDeploymentGroupOperationMetadata(message)ProvisionDeploymentGroupOperationMetadata.DeploymentStep(enum)RegisterAppHubApplicationResourcesRequest(message)RegisterAppHubApplicationResourcesResponse(message)RegisterApphubResourcesRequest(message)RegisterApphubResourcesResponse(message)RegisterDeployedApplicationRequest(message)RegisterDeployedApplicationResponse(message)RegisterDeployedResourcesRequest(message)RegisterDeployedResourcesResponse(message)RemediationStep(message)Resource(message)Resource.State(enum)ResourceType(message)RootInputVariable(message)RootModule(message)RootModuleDependency(message)RootModulesMetadata(message)RootOutputVariable(message)SCCMetadata(message)SaaSRuntimeContext(message)ScoreCard(message)SerializedApplicationTemplate(message)SerializedComponent(message)SerializedConnection(message)SetupADCRequest(message)SetupADCResponse(message)Share(message)Share.State(enum)SharedTemplate(message)SharedTemplateRevision(message)SkippedDomain(message)SkippedDomain.Reason(enum)Space(message)SyncShareRequest(message)TFBlueprintMetadata(message)TemplateCategory(enum)TemplateConnections(message)TemplateInfo(message)TemplateRequirements(message)TemplateRoles(message)TemplateSchema(message)TemplateType(enum)TemplateUi(message)TemplateUiInput(message)TemplateVariable(message)TerraformBlueprintUiMetadata(message)TerraformConfig(message)TerraformFile(message)TerraformInput(message)TerraformInputConnections(message)TerraformModule(message)TerraformModuleConfig(message)TerraformOutput(message)TerraformUiInput(message)TerraformUiInputDisplayVariable(message)TerraformUiOutput(message)TerraformUiOutputDisplay(message)UnregisteredResource(message)UpdateApplicationRequest(message)UpdateApplicationTemplateRequest(message)UpdateCatalogRequest(message)UpdateCatalogTemplateRequest(message)UpdateComponentRequest(message)UpdateConnectionRequest(message)UpdatePolicyRequest(message)UpdateSpaceRequest(message)UpdatedTemplateRevision(message)ValueLabel(message)ValueLabelInput(message)
DesignCenter
Service describing handlers for resources
| CommitApplicationTemplate |
|---|
|
Commits an application template to create a new revision.
|
| CreateApplication |
|---|
|
Creates an application.
|
| CreateApplicationTemplate |
|---|
|
Creates an application template.
|
| CreateCatalog |
|---|
|
Creates a catalog.
|
| CreateCatalogTemplate |
|---|
|
Adds a template to a catalog.
|
| CreateCatalogTemplateRevision |
|---|
|
Creates a template revision.
|
| CreateComponent |
|---|
|
Creates a component.
|
| CreateConnection |
|---|
|
Creates a connection.
|
| CreatePolicy |
|---|
|
Creates a policy for an application template.
|
| CreateSpace |
|---|
|
Creates a space.
|
| DeleteApplication |
|---|
|
Deletes an application.
|
| DeleteApplicationTemplate |
|---|
|
Deletes an application template.
|
| DeleteApplicationTemplateRevision |
|---|
|
Deletes an application template revision.
|
| DeleteCatalog |
|---|
|
Deletes a catalog.
|
| DeleteCatalogTemplate |
|---|
|
Deletes a catalog template.
|
| DeleteCatalogTemplateRevision |
|---|
|
Deletes a template revision.
|
| DeleteComponent |
|---|
|
Deletes a component.
|
| DeleteConnection |
|---|
|
Deletes a connection.
|
| DeletePolicy |
|---|
|
Deletes a policy.
|
| DeleteSpace |
|---|
|
Deletes a space.
|
| DeployApplication |
|---|
|
Deploys an application.
|
| ExportApplicationTemplateIaC |
|---|
|
Exports Terraform files for an application template. The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.
|
| ExportApplicationTemplateRevisionIaC |
|---|
|
Exports Terraform files for an application template revision. The generated modules can have remote sources or local sources downloaded from remote. This is an ASYNCHRONOUS operation that returns a Long Running Operation.
|
| FetchApplicationAssessmentReport |
|---|
|
Fetches the assessment report of a deployed application if present.
|
| FetchFrameworks |
|---|
|
Fetches all frameworks for assessment report.
|
| GenerateApplicationIaC |
|---|
|
Generates Terraform files for an application.
|
| GenerateApplicationTemplateAssessmentReport |
|---|
|
Generate Assessment Reports of an application template.
|
| GenerateApplicationTemplateIaC |
|---|
|
Generates Terraform files for an application template. This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.
|
| GenerateApplicationTemplateRevisionIaC |
|---|
|
Generates Terraform files for an application template revision. This is a SYNCHRONOUS operation and returns the generated IaC directly in the response. It does NOT download external module sources; it only uses remote sources.
|
| GenerateAssessmentReport |
|---|
|
Generate a best practice report for a given Terraform plan.
|
| GetApplication |
|---|
|
Gets details about an application.
|
| GetApplicationTemplate |
|---|
|
Gets details about an application template.
|
| GetApplicationTemplateRevision |
|---|
|
Gets details about an application template revision.
|
| GetApplicationTemplateSystemRevision |
|---|
|
Gets the given application template system revision.
|
| GetCatalog |
|---|
|
Gets details about a catalog.
|
| GetCatalogTemplate |
|---|
|
Gets a catalog template.
|
| GetCatalogTemplateRevision |
|---|
|
Gets details about a template revision.
|
| GetComponent |
|---|
|
Gets details about a Component.
|
| GetConnection |
|---|
|
Gets details about a connection.
|
| GetPolicy |
|---|
|
Policy related APIs. Get a policy for an application template.
|
| GetSpace |
|---|
|
Gets details about a space.
|
| ImportApplicationIaC |
|---|
|
Imports IaC for an application resource.
|
| ImportApplicationTemplate |
|---|
|
Imports to an existing application template from a given shared template.
|
| ImportApplicationTemplateIaC |
|---|
|
Imports IaC for an application template.
|
| InferConnections |
|---|
|
Infers and suggests connections between components within a space. The generated connection information can be used in application templates and designs.
|
| ListApplicationTemplateRevisions |
|---|
|
Lists application template revisions in a given application template.
|
| ListApplicationTemplateSystemRevisions |
|---|
|
Lists application template system revisions in a given application template.
|
| ListApplicationTemplates |
|---|
|
Lists application templates in a given space.
|
| ListApplications |
|---|
|
Lists applications in a given space.
|
| ListCatalogTemplateRevisions |
|---|
|
Lists template revisions.
|
| ListCatalogTemplates |
|---|
|
Lists catalog templates.
|
| ListCatalogs |
|---|
|
Lists catalogs in a given space.
|
| ListComponents |
|---|
|
Lists components in an application template.
|
| ListConnections |
|---|
|
Lists connections in an application template.
|
| ListPolicies |
|---|
|
Lists policies for an application template.
|
| ListSpaces |
|---|
|
Lists spaces in a given project and location.
|
| PreviewApplication |
|---|
|
Previews deployment of an application.
|
| RegisterAppHubApplicationResources |
|---|
|
Register deployed resources from terraform state file with App Hub without needing a space.
|
| RegisterDeployedApplication |
|---|
|
Register deployed application from terraform state file with App Hub.
|
| RegisterDeployedResources |
|---|
|
Register deployed resources from terraform state file with App Hub.
|
| UpdateApplication |
|---|
|
Updates an application.
|
| UpdateApplicationTemplate |
|---|
|
Updates an application template.
|
| UpdateCatalog |
|---|
|
Updates a catalog.
|
| UpdateCatalogTemplate |
|---|
|
Updates a catalog template resource.
|
| UpdateComponent |
|---|
|
Updates a component.
|
| UpdateConnection |
|---|
|
Updates a connection.
|
| UpdatePolicy |
|---|
|
Updates a policy.
|
| UpdateSpace |
|---|
|
Updates a space.
|
DesignCenterInternal
DesignCenterInternal is a service that is used to host private APIs.
| AssessBestPractices |
|---|
|
Assesses best practices for an application template.
|
| FetchApplication |
|---|
|
Fetch Application given apphub Application Name
|
| FetchCatalogTemplateRevisionTFSource |
|---|
|
Gets the Terraform source of a catalog template revision.
|
| ImportSerializedApplicationTemplate |
|---|
|
Imports a serialized application template.
|
| ManageApplication |
|---|
|
Manages application resource.
|
| ManageApplicationTemplate |
|---|
|
Manages application template resource.
|
| RegisterApphubResources |
|---|
|
Registers a list of deployed GCP resources with App Hub.
|
| SetupADC |
|---|
|
Sets up Design Center in a given project and location.
|
AdcMetadata
Application Design Center specific information and metadata.
| Fields | |
|---|---|
Union field app_uri. Application or ApplicationTemplate URI app_uri can be only one of the following: |
|
application_uri |
Output only. Application URI |
application_template_uri |
Output only. ApplicationTemplate URI |
space_uri |
Output only. Space URI |
AlternateDefault
Alternate default for a UI input.
| Fields | |
|---|---|
type |
Output only. Type of alternate default. |
value |
Output only. Value of the alternate default. |
AlternateDefaultInput
Alternate default input for a UI.
| Fields | |
|---|---|
type |
Optional. Type of alternate default. |
value |
Optional. Value of the alternate default. |
AppHubApplicationParameters
App Hub application parameters.
| Fields | |
|---|---|
application_id |
Optional. The App Hub application ID. |
scope |
Optional. The App Hub application scope. |
attributes |
Optional. The App Hub application attributes. |
location |
Optional. The App Hub application location. Only used for applications with REGIONAL scope. |
host_project_id |
Optional. The host project ID where the App Hub application is created. |
Application
Represents the application resource.
| Fields | |
|---|---|
name |
Identifier. The name of the application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application} |
create_time |
Output only. Create timestamp. |
update_time |
Output only. Update timestamp. |
source |
Required. The application deployment source. |
app_parameters[] |
Optional. A list of parameters to attach to the deployment source object, which is a catalog entry or application template snapshot. |
component_parameters[] |
Optional. A list of component parameters to associate with the application. |
service_account |
Optional. Your own service account that you use to deploy an application. |
display_name |
Optional. Display name of the application. |
description |
Optional. Description of the application. |
attributes |
Optional. Attributes of the application. |
scope |
Required. Scope of the application. |
import_existing_resources |
Optional. Import existing resources into the application. |
preview_reference |
Output only. Preview reference for the application. |
deployment_revision |
Output only. [Output only] Optional Infra Manager deployment Id with revision |
apphub_application |
Output only. The App Hub App associated with the application. |
serialized_application_template |
Output only. [Output only] Serialized application template. |
state |
Output only. Deployment state of the application. |
deployment_metadata |
Output only. Deployment metadata of the application. |
project_parameters[] |
Output only. List of project parameters for the application. |
deployment_region |
Optional. The region where the application is deployed. |
updated_template_revision |
Output only. The updated template revision because of which the application is outdated. |
deployment_project |
Optional. Deployment project of the application. |
connection_configs[] |
Optional. Connection configuration for the application. |
artifact_location |
Output only. Details of the location where the IaC for this application was last successfully exported. |
type |
Optional. The type of the application. |
deployment_target |
Optional. The deployment target of the application. |
composition_type |
Output only. The composition type of the application: STANDARD OR COMPOSITE. |
composite_application_parameters |
Optional. Parameters that are required for composite applications. |
deployment_group_metadata |
Output only. The deployment group metadata of the application. This is applicable only for composite applications. |
params_update_strategy |
Optional. Specifies the strategy to use when updating the application parameters while updating the application template revision. |
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. |
UpdateStrategy
Specifies the strategy to use when updating an application.
| Enums | |
|---|---|
UPDATE_STRATEGY_UNSPECIFIED |
Retains the existing value for the field. |
REPLACE |
Replaces the existing field values with the provided ones. |
ApplicationCompositionType
The composition type of the applicationTemplate or application: STANDARD OR COMPOSITE.
| Enums | |
|---|---|
APPLICATION_COMPOSITION_TYPE_UNSPECIFIED |
ApplicationCompositionType is UNSPECIFIED. |
STANDARD |
ApplicationCompositionType is STANDARD. The applicationTemplate or application is composed of components only of type service/workload/asset and has a single root module in terraform code. |
COMPOSITE |
ApplicationCompositionType is COMPOSITE. The template is composed of STANDARD applicationTemplate(s) and might be having multiple root modules in terraform code. |
ApplicationOperation
Represents the type of operation to perform on an application.
| Enums | |
|---|---|
APPLICATION_OPERATION_UNSPECIFIED |
The default value. This value is unused. |
APPLICATION_OPERATION_CREATE |
Creates a new application. |
APPLICATION_OPERATION_UPDATE |
Updates an existing application. |
APPLICATION_OPERATION_PREVIEW |
Previews a deployment of an application. |
APPLICATION_OPERATION_DEPLOY |
Deploys an application. |
APPLICATION_OPERATION_GET |
Gets an application. |
APPLICATION_OPERATION_GENERATE_IAC |
Generates IaC for an application. |
ApplicationOperationMetadata
Ephemeral metadata depicting the state of the delete operation.
| Fields | |
|---|---|
step |
Output only. The current step of the delete operation. Associated with Infrastructure Manager and App Hub. |
build |
Output only. Cloud Build instance UUID associated with the delete operation. |
ApplicationOperationResponse
Response message for an asynchronous application operation.
| Fields | |
|---|---|
operation |
Output only. The long-running operation. |
operation_type |
Output only. The type of the operation. |
OperationType
The type of the operation.
| Enums | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
The default value. This value is unused. |
PREVIEW |
The operation is a preview. |
DEPLOY |
The operation is a deployment. |
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 |
Output only. Helm application output parameters. |
ApplicationTemplate
Application template resource.
| Fields | |
|---|---|
name |
Identifier. Application template name. |
display_name |
Optional. Application template display name. |
description |
Optional. Application template description. |
create_time |
Output only. Application template creation timestamp. |
update_time |
Output only. Application template update timestamp. |
application_parameters[] |
Optional. Parameters to apply to all components in an application. You can specify projectID and region. |
iac_format |
Output only. The IaC format of the application template. |
serialized_application_template |
Output only. The serialized application template. |
latest_revision |
Output only. The latest application template revision. |
artifact_location |
Output only. Details of the location where the IaC for this ApplicationTemplate was last successfully exported. |
composition_type |
Optional. Immutable. The composition type of the applicationTemplate: STANDARD OR COMPOSITE. This is a create time only param. |
root_input_variables[] |
Optional. Root level input variables of the application template. |
root_output_variables[] |
Optional. Root level output variables of the application template. |
saas_runtime_context |
Optional. SaaS runtime context for the application template. |
latest_system_revision_uri |
Output only. The URI of the most recent System Revision generated for this ApplicationTemplate. This ID corresponds to the |
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. |
ApplicationTemplateOperation
Represents the type of operation to perform on an application template.
| Enums | |
|---|---|
APPLICATION_TEMPLATE_OPERATION_UNSPECIFIED |
The default value. This value is unused. |
APPLICATION_TEMPLATE_OPERATION_CREATE |
Creates a new application template. |
APPLICATION_TEMPLATE_OPERATION_UPDATE |
Updates an existing application template. |
APPLICATION_TEMPLATE_OPERATION_COMMIT |
Commits an application template to create a new revision. |
APPLICATION_TEMPLATE_OPERATION_GENERATE_IAC |
Generates IaC for an application template. |
APPLICATION_TEMPLATE_OPERATION_GET |
Gets an application template. |
APPLICATION_TEMPLATE_OPERATION_IMPORT_IAC |
Imports an application template from IaC. |
APPLICATION_TEMPLATE_OPERATION_UPDATE_COMPONENT_PARAMETERS |
Updates component parameters from IaC. |
ApplicationTemplateRevision
Application template revision resource.
| Fields | |
|---|---|
name |
Identifier. The application template revision name. |
create_time |
Output only. The application template revision creation timestamp. |
snapshot |
Output only. The serialized application template. |
artifact_location |
Output only. Details of the location where the IaC for this ApplicationTemplate Revision was last successfully exported. |
ApplicationTemplateSystemRevision
Application template system revision resource.
| Fields | |
|---|---|
name |
Identifier. The application template system revision name. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/systemRevisions/{system_revision} |
create_time |
Output only. The application template system revision creation timestamp. |
annotations |
Output only. Annotations from agentic workflows or other system processes. For example: { "designcenter.googleapis.com/agent_id": "gemini-3-flash-v1", "designcenter.googleapis.com/llm_agent_summary": "Added a Cloud SQL instance", "designcenter.googleapis.com/external_ref_id": "trace-uuid-88921-xyz" } |
snapshot |
Output only. The serialized application template snapshot at this revision. |
ApplicationType
The type of the application.
| Enums | |
|---|---|
APPLICATION_TYPE_UNSPECIFIED |
Application type is unspecified. |
TERRAFORM_APP |
Application type is terraform application. |
HELM_APP |
Application type is helm application. |
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 |
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 |
Optional. The Cloud Storage URI for storing the generated IaC. |
AssessBestPracticesRequest
Request message for AssessBestPractices.
| Fields | |
|---|---|
application_template |
Required. The full resource name of application template. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{applicationTemplate} |
AssessBestPracticesResponse
A comprehensive assessment report that evaluates an Application Template against industry-standard security and operational benchmarks.
| Fields | |
|---|---|
application_template |
Output only. The full canonical Google Cloud resource path of the application template being assessed. |
assessment_results[] |
A collection of evaluation sets, grouped by the specific security or best-practice framework used. |
summary |
Output only. A brief summary of the assessment results. |
AssessmentResult
The result of the assess best practices for a framework.
| Fields | |
|---|---|
framework |
Output only. The formal name of the regulatory or architectural standard (e.g., NIST, CIS, or Internal Policy). |
findings[] |
Individual instances where the template deviates from the 'Gold Standard' best practices. |
AssessmentFinding
The details of the assessment finding.
| Fields | |
|---|---|
description |
Output only. A clear, human-readable explanation of the finding and why it matters for template quality. |
severity |
Output only. The risk level of the finding. |
AssessedFramework
Framework assessed and their findings.
| Fields | |
|---|---|
framework |
Required. The framework that was assessed. |
findings[] |
Required. A list of every Finding found during the assessment. |
score_card |
Optional. Score card associated with the report. |
skipped |
Optional. Whether the framework was skipped during assessment. |
skipped_reason |
Optional. Reason for skipping the framework during assessment. |
AssessmentFinding
Details of an Assessment Finding.
| Fields | |
|---|---|
id |
Output only. The Finding ID. |
assessed_framework_id |
Optional. The framework that was assessed. |
adc_metadata |
Output only. Metadata related to the Application Design Center with the finding. |
finding_type |
Required. The type of the finding. Findings can be informational, warning, or error. |
severity |
Optional. The severity of the finding. |
assessed_asset |
Required. Details of the Cloud Asset Inventory asset that was assessed. |
assessed_framework |
Optional. Details of the framework that was assessed. |
description |
Optional. Description of the finding. |
findings_uri |
Optional. Link to the findings, if persisted by the domain. |
scc_metadata |
Output only. SCC related metadata for the finding. |
Union field next_step. Next steps related to the findings. next_step can be only one of the following: |
|
remediation_step |
Optional. A description of the steps that users can take to fix the finding. |
Union field additional_details. Additional details about the finding. additional_details can be only one of the following: |
|
additional_notes |
Optional. A description of the additional details about finding. |
FindingADCMetadata
Metadata related to the Application Design Center with the finding.
| Fields | |
|---|---|
component_name |
Output only. Component the finding belongs to. |
Severity
The severity of a finding.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED |
Default value. This value is unused. |
CRITICAL |
Critical severity. |
HIGH |
High severity. |
MEDIUM |
Medium severity. |
LOW |
Low severity. |
Type
The type of finding.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Default value. This value is unused. |
WARNING |
Warning finding. Deployment will not be blocked. |
ERROR |
Error finding. Deployment will be blocked on ERROR. |
AssessmentReport
Aggregated assessment report from all domains.
| Fields | |
|---|---|
domain_assessment_reports[] |
Output only. Generated best practice reports. |
skipped_domains[] |
Output only. Skipped domains. |
create_time |
Output only. The time at which the report was created. |
Union field adc_resource_uri. Resource associated with the report. adc_resource_uri can be only one of the following: |
|
adc_application_uri |
Output only. Application URI. |
adc_application_template_uri |
Output only. Application Template URI. |
adc_catalog_template_uri |
Output only. Catalog Template URI. |
adc_space_uri |
Output only. Space URI. |
AssetDetails
Details of a Cloud Asset Inventory asset that caused the finding.
| Fields | |
|---|---|
asset_id |
Required. Information about the Cloud Asset Inventory asset that the framework is assessed against. The full resource name of the asset in CAIS format. For details about the format of the full resource name for each asset type, see Resource name format. |
asset_type |
Optional. The type of Cloud Asset Inventory asset. For a list of asset types, see Supported asset types. |
Catalog
A collection of templates.
| Fields | |
|---|---|
name |
Identifier. The catalog name in the following format: |
display_name |
Optional. The catalog display name. |
description |
Optional. The catalog description. |
create_time |
Output only. The catalog creation timestamp. |
update_time |
Output only. The catalog update timestamp. |
CatalogTemplate
A template inside a catalog.
| Fields | |
|---|---|
name |
Identifier. The catalog template name in following format: |
display_name |
Optional. The display name of a catalog template. |
description |
Optional. The catalog template description. |
uuid |
Output only. The template revisions UUID. |
create_time |
Output only. The catalog template creation timestamp. |
update_time |
Output only. The catalog template update timestamp. |
latest_revision_id |
Output only. Latest revision of the template. |
template_category |
Required. The category of the Application Design Center assembly template. |
type |
Optional. The Application Design Center assembly template type. |
CatalogTemplateRevision
Template revisions inside a catalog.
| Fields | |
|---|---|
name |
Identifier. The catalog template revision name. |
description |
Optional. The catalog template revision description. |
type |
Optional. The Application Design Center assembly template type. |
create_time |
Output only. The catalog template creation timestamp. |
update_time |
Output only. The catalog template update timestamp. |
template_metadata |
Output only. Template metadata related to Terraform input and output. |
state |
Output only. The template state (validating/ready/invalid). |
application_template_revision |
Output only. The application template revision. |
helm_chart_metadata |
Output only. The helm chart metadata. |
uuid |
Output only. UUID of the template revision. |
metadata_input |
Optional. Metadata input. |
template_category |
Output only. The category of the template. |
logical_products[] |
Output only. The Product Main logical product type information. |
annotations |
Optional. The annotations of the template revision. Key is the annotation name. Value is the annotation value. |
inferred_metadata |
Output only. Metadata that was automatically inferred from the template content. This field can be updated by the system as it gets new information. |
resource_types[] |
Output only. The resource types present in the template revision. |
Union field artifact_location. The artifact location of the Terraform in the template. artifact_location can be only one of the following: |
|
git_source |
Optional. The git source. |
gcs_source_uri |
Optional. The Cloud Storage URI, which must be in the format gs://[bucket] or gs://[bucket]/[object]. |
application_template_revision_source |
Optional. The application template revision source. |
developer_connect_source_config |
Optional. Configuration for fetching content from source code repository such as GitHub or Bitbucket through Developer Connect. |
oci_repo |
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. |
CloudControl
Cloud control for a framework.
| Fields | |
|---|---|
name |
Required. The name of the cloud control. |
description |
Optional. The description of the cloud control. |
major_revision_id |
Required. The major revision id of the cloud control. |
enforcement_mode |
Optional. The enforcement mode of the cloud control. |
EnforcementMode
Enum for enforcement mode of a cloud control.
| Enums | |
|---|---|
ENFORCEMENT_MODE_UNSPECIFIED |
Enforcement type unspecified. |
PREVENTIVE |
The cloud control is enforced to prevent non-compliance. |
DETECTIVE |
The cloud control is enforced to detect non-compliance. |
AUDIT |
The cloud control is enforced to audit for non-compliance. |
CodePosition
CodePosition represents a code location.
| Fields | |
|---|---|
line |
Output only. One-based line count of the relevant position. |
byte_offset |
Output only. Byte offset in the content. |
column |
Output only. One-based column count of the relevant position. |
CodeRange
CodeRange represents a portion of code.
| Fields | |
|---|---|
start |
Output only. Start position. |
end |
Output only. End position. |
CommitApplicationTemplateRequest
Request message for CommitApplicationTemplate method.
| Fields | |
|---|---|
name |
Required. The name of the application template. |
Component
Component resource.
| Fields | |
|---|---|
name |
Identifier. The component name. |
shared_template_revision_uri |
Required. Immutable. The shared template used to generate the component. |
parameters[] |
Optional. The component parameters. |
create_time |
Output only. The component creation timestamp. |
update_time |
Output only. The component update timestamp. |
roles[] |
Output only. IAM roles required by the service account to deploy the component. |
apis[] |
Output only. APIs required to be enabled to deploy the component, in the form of "*.googleapis.com". |
display_name |
Optional. The component display name. |
connections_parameters[] |
Output only. The connection parameters of the component. |
component_parameter_schema[] |
Output only. The component parameter schema, which includes possible parameter values. values. |
application_info |
Optional. The application associated with the component. |
ComponentApplicationInfo
This captures the apphub application details associated with the component.
| Fields | |
|---|---|
apphub_application_id |
Required. The application ID of the apphub application. The ID must be 1-63 characters long and should match the regular expression |
display_name |
Optional. Display name for the application. The number of characters should be less than 64 characters. |
scope |
Optional. Scope of apphub application. |
attributes |
Optional. Attributes of apphub application. |
deployment_region |
Optional. Deployment region for the component. If the scope is set to REGIONAL, then the apphub application is created in this region, e.g. |
ComponentOutputParameters
The component output parameters of the deployment.
| Fields | |
|---|---|
component |
Output only. The component name of the output parameters. |
parameters[] |
Output only. The output parameters of the component. |
ComponentParameterSchema
Component parameter schema, which contains a list of all component parameters.
| Fields | |
|---|---|
key |
Output only. The key of the parameter. |
default_value |
Output only. The default value of the parameter. |
is_required |
Output only. Whether the parameter is required. |
type |
Output only. The type of the parameter. |
ComponentParameters
Information about the component level parameters for an application.
| Fields | |
|---|---|
component |
Required. The name of the component parameter. |
parameters[] |
Optional. A list of parameters associated with the component. |
connections_parameters[] |
Output only. A list of connections associated with the component. |
state |
Output only. Deployment state of the component. |
component_parameter_schema[] |
Output only. The component parameter schema, which includes possible parameter values. |
application_info |
Optional. The application associated with the component. |
effective_application_info |
Output only. The effective application associated with the component. This is the server set application field. |
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. |
ComponentVariable
The details of an input/output variable: the variable and the component Uri. name.
| Fields | |
|---|---|
variable |
Required. Name of the variable. |
component_uri |
Required. Component to which this variable belongs. |
CompositeApplicationParameters
Holds parameters that are specific to composite applications.
| Fields | |
|---|---|
service_account_map |
Optional. A map from a component's URI to the deployment service account for composite application. key format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} value format: projects/{project}/serviceAccounts/{email_address} |
project_parameters_map |
Output only. A map from a component's URI to its project parameters. The key format is: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} |
Connection
Connection resource.
| Fields | |
|---|---|
name |
Identifier. The connection name. |
destination_component_uri |
Required. The destination component URI used to generate the connection. Format is |
create_time |
Output only. The connection creation timestamp. |
update_time |
Output only. The connection update timestamp. |
source_component_parameters[] |
Optional. The parameters of the connection associated with the source component. |
destination_component_parameters[] |
Optional. The parameters of the connection associated with the destination component. |
ConnectionConfig
Connection configuration for the application.
| Fields | |
|---|---|
connection_uri |
Required. The connection URI. |
source_component_parameters[] |
Optional. The parameters of the connection associated with the source component. |
destination_component_parameters[] |
Optional. The parameters of the connection associated with the destination component. |
ConnectionParameters
Connection level parameters associated with each component within an application.
| Fields | |
|---|---|
connection |
Required. The name of the connection parameter. |
parameters[] |
Optional. A list of parameters associated with the connection. |
ConnectionSource
Defines the source of a connection.
| Fields | |
|---|---|
source |
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 |
Required. Version constraint syntax using the same format as module version constraints. |
ConnectionSpec
Defines the specifications of a connection.
| Fields | |
|---|---|
output_expr |
Required. Output expression identifying output being connected to variable. |
input_path |
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 |
Required. The parent resource in which to create the application. Format: |
application_id |
Required. The ID of the application to create. |
application |
Required. The application to create. |
CreateApplicationTemplateRequest
Message for creating an application template.
| Fields | |
|---|---|
parent |
Required. The parent resource in which to create the application template. |
application_template_id |
Required. The ID of the application template to create. |
application_template |
Required. The application template to create. |
CreateCatalogRequest
Message for creating a catalog.
| Fields | |
|---|---|
parent |
Required. The parent space in which a catalog is created in the following format: |
catalog_id |
Required. The ID of the catalog to create. |
catalog |
Required. The catalog to create. |
CreateCatalogTemplateRequest
Message for creating a catalog template.
| Fields | |
|---|---|
parent |
Required. The parent resource in which the catalog template is created. |
catalog_template_id |
Required. The ID of the catalog template to create. The ID is appended to the catalog template's name. |
catalog_template |
Required. The catalog template to create. |
CreateCatalogTemplateRevisionRequest
Message for creating a template revisions request.
| Fields | |
|---|---|
parent |
Required. The parent in which the catalog template revisions request is created in following format: |
catalog_template_revision_id |
Required. The ID of the template revision to create. |
catalog_template_revision |
Required. The template revision to create. |
CreateComponentRequest
Message for creating a component.
| Fields | |
|---|---|
parent |
Required. The parent resource in which to create the component. |
component_id |
Required. The ID of the component to create. |
component |
Required. The component to create. |
CreateConnectionRequest
Message for creating a connection.
| Fields | |
|---|---|
parent |
Required. The parent resource in which to create a connection. |
connection_id |
Required. The ID of the connection to create. |
connection |
Required. The connection to create. |
CreatePolicyRequest
Message for creating a policy.
| Fields | |
|---|---|
parent |
Required. The parent resource in which to create the policy in the following format: |
policy_id |
Required. The ID of the policy to create. |
policy |
Required. The policy to create. |
CreateSpaceRequest
Message for creating a space.
| Fields | |
|---|---|
parent |
Required. The parent in which to create a space. |
space_id |
Required. The ID of the space to create. |
space |
Required. The space to create. |
DeleteApplicationRequest
Message for deleting an application.
| Fields | |
|---|---|
name |
Required. The application name. Format: |
force |
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 |
Required. The application template name. |
force |
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 |
Required. The application template revision name. |
DeleteCatalogRequest
Message for deleting a catalog.
| Fields | |
|---|---|
name |
Required. The catalog name in the following format: |
force |
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 |
Required. The catalog template name. Format: |
force |
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 |
Required. The template revision name. |
DeleteComponentRequest
Message for deleting a component.
| Fields | |
|---|---|
name |
Required. The component name. |
force |
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 |
Required. The connection name. |
DeletePolicyRequest
Message for deleting a policy.
| Fields | |
|---|---|
name |
Required. The policy name in the following format: |
DeleteSpaceRequest
Message for deleting a space.
| Fields | |
|---|---|
name |
Required. The space name. |
force |
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 |
Required. The application name. Format: |
replace |
Optional. Flag to update the existing deployment. If not set or false, deploy will fail if application |
worker_pool |
Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application. |
service_account |
Optional. The email address of the service account to use for this deployment.
|
DeployApplicationResponse
Response for DeployApplication.
| Fields | |
|---|---|
deployment |
Infrastructure Manager deployment. |
build_id |
Cloud Build deployment id. |
deployment_group |
Infrastructure Manager deployment group. Used for composite application deployment response. |
DeployedResource
DeployedResource represents a single deployed GCP resource.
| Fields | |
|---|---|
resource_id |
Required. The full resource name of the deployed GCP resource. Example: projects/my-project/locations/us-central1-a/instances/my-instance |
project |
Optional. The project ID of the deployed resource. |
location |
Optional. The location of the deployed resource. |
DeployedResourceResponse
Common response message for the resource registration methods.
| Fields | |
|---|---|
apphub_application |
The App Hub application name. |
registered_resources[] |
The list of successfully registered GCP resources. |
unregistered_resources[] |
The list of unregistered GCP resources with error details. |
DeploymentAttemptMetadata
DeploymentAttemptMetadata represents a previous deployment attempt for an operation that failed due to a retryable error.
| Fields | |
|---|---|
attempt |
The sequential number of the attempt (starting from 1). |
error_detail |
Human readable string that summarizes the deployment error issue. |
build |
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 |
Output only. The error type based on the deployment error code. |
code |
Output only. The deployment error code. Based on Infrastructure Manager error codes. |
tf_errors[] |
Output only. The error message associated with the deployment. |
detail |
Output only. Human readable string that summarizes the deployment error issue. |
deployment_failure_resolution_info[] |
Output only. The call to actions associated with the deployment issue. |
error_message |
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_link |
Output only. Link for the call to action. |
resolution_message |
Output only. Elaborative error resolution message. |
resolution_link_text |
Output only. Call to action link text. |
DeploymentGroupMetadata
Metadata for the infra manager deployment group. A deployment group in Infrastructure Manager is a logical grouping of one or more deployments.
| Fields | |
|---|---|
deployment_group |
Output only. The deployment group name. Format: projects/{project}/locations/{location}/deploymentGroup/{deployment_group} |
deployment_metadata_map |
Output only. Map of component name to deployment metadata for the component. Key format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/components/{component} |
DeploymentMetadata
Deployment information for the application.
| Fields | |
|---|---|
revision |
Output only. The revision of the deployment associated with the Application. |
component_output_parameters[] |
Output only. The component output parameters of the deployment. |
error |
Output only. The error associated with the deployment. |
build |
Output only. Cloud Build instance UUID associated with this deployment. |
worker_pool |
Output only. The user-specified Cloud Build worker pool resource used, which the system uses to deploy the application. Format: |
retry_attempts |
Output only. The attempted number of deployment retries. |
application_output_parameters |
Output only. The application output parameters of the deployment. |
DeploymentOperationMetadata
Ephemeral metadata depicting the state of the deployment operation.
| Fields | |
|---|---|
deployment |
Output only. The name of the deployment associated with the application. |
deployment_step |
Output only. The current step of the deployment. This will mimic the DeploymentStep enum in the deployment proto. |
deployment_build |
Output only. Cloud Build instance UUID associated with this deployment. |
deployment_logs |
Output only. Location of the deployment operation logs in |
resources[] |
Details of the [Resources][]s in the deployment. |
previous_attempt |
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 |
Application template revision URI. |
shared_template_revision_uri |
Shared template revision URI. |
DeploymentTarget
The deployment target of the application.
| Fields | |
|---|---|
Union field target. Different deployment targets for the application. target can be only one of the following: |
|
gke_deployment_target |
Optional. The GKE deployment target. |
DeploymentUnitProgress
Single deployment unit progress info
| Fields | |
|---|---|
unit_id |
Output only. Deployment unit ID |
deployment |
Output only. Deployment resource of deploying unit ID |
deployment_unit_step |
Output only. Current deployment unit step |
deployment_build |
Output only. Deployment build uuid |
deployment_step |
Output only. Current deployment step |
DeveloperConnectConfig
This config defines the location of a source through Developer Connect.
| Fields | |
|---|---|
git_repository_link |
Required. The Developer Connect Git repository link, formatted as |
DeveloperConnectExportConfig
Through Developer Connect, defines a location where content such as Infrastructure as Code (IaC) is stored.
| Fields | |
|---|---|
developer_connect_repo_uri |
Required. The Developer Connect Git repository link, formatted as |
branch |
Optional. The branch in repo to which the content such as Infrastructure as Code (IaC) should be written to. If empty, Application Design Center will create a branch and push the changes. |
dir |
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 |
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 |
Required. The Developer Connect Git repository link, formatted as |
reference |
Required. The reference (for example, a branch, tag, or commit SHA) from which the content should be read. |
dir |
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 |
Output only. The SHA of the commit deduced from GitReference. |
DisplayVariable
Additional display specific Template pertaining to a particular input variable.
| Fields | |
|---|---|
name |
Required. The variable name from the corresponding standard Template file. |
title |
Required. Visible title for the variable on the UI. |
alternate_defaults[] |
Optional. Alternate defaults for the input. |
regex_validation |
Optional. Regex based validation rules for the variable. |
validation |
Optional. 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[] |
Optional. Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters. |
level |
Optional. 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 |
Optional. Property subtext, displayed below the title. |
properties |
Optional. properties is a map defining all the fields of the input variable. |
min |
Optional. Minimum value for numeric types. |
max |
Optional. Maximum value for numeric types. |
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 |
Output only. The name of the variable used to toggle the display of another variable. |
variable_values[] |
Output only. The value of the variable used to toggle the display of another variable. |
variable_type |
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. |
Domain
Domain for assessment.
| Fields | |
|---|---|
domain_name |
Required. The domain name. Uniquely identifies the domain. |
display_name |
Optional. The domain display name is user friendly name used for UI. |
description |
Optional. The domain description. |
frameworks[] |
Optional. The frameworks that are applicable in this domain. |
inactive |
Optional. Whether the domain is inactive. Default: false. |
DomainAssessmentReport
The assessment report for each domain.
| Fields | |
|---|---|
report_name |
Optional. The report name as per Application Design Center. |
domain_id |
Output only. The ID of the domain. |
create_time |
Output only. The time at which the report was created. |
update_time |
Output only. The time at which the report was last updated. |
status |
Optional. Status of assessment report. |
adc_metadata |
Output only. Specific information and metadata. |
assessed_frameworks[] |
Required. List of frameworks assessed and their findings. |
additional_info |
Optional. Additional information about the report. |
skipped_asset_types[] |
Optional. List of asset types skipped during assessment. |
domain_redirect_info |
Optional. Information on how to redirect to domain. |
report_score |
Output only. Score card associated with the report. |
DomainRedirectInfo
Information on how to redirect to domain.
| Fields | |
|---|---|
url |
Required. URL to the domain page. |
url_text |
Required. Text to display in UI on the redirect URL. |
open_in_same_tab |
Optional. Flag to open the URL in new tab. Default: false. |
Status
Status of domain assessment report.
| Enums | |
|---|---|
STATUS_UNSPECIFIED |
No status specified. |
PENDING |
Pending domain assessment. |
COMPLETED |
Complete domain assessment. |
FAILED |
Failed domain assessment. |
ExportApplicationTemplateIaCRequest
Request message for ExportApplicationTemplateIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application template. |
artifact_location |
Optional. Specifies the destination for the generated IaC, which can be Cloud Storage or a Developer Connect repository. Default is Google Cloud Storage. |
export_iac_config |
Optional. Configuration for exporting IaC. |
ExportApplicationTemplateIaCResponse
Response message for ExportApplicationTemplateIaC method.
| Fields | |
|---|---|
artifact_location |
The destination where the generated IaC was written. |
root_modules_metadata |
Root modules metadata of the application template. |
ExportApplicationTemplateRevisionIaCRequest
Request message for ExportApplicationTemplateRevisionIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application template revision. |
artifact_location |
Optional. Specifies the destination for the generated IaC, which can be Cloud Storage or a Developer Connect repository. Default is Google Cloud Storage. |
export_iac_config |
Optional. Configuration for exporting IaC. |
ExportApplicationTemplateRevisionIaCResponse
Response message for ExportApplicationTemplateRevisionIaC method.
| Fields | |
|---|---|
artifact_location |
The destination where the generated IaC was written. |
root_modules_metadata |
Root modules metadata of the application template revision. |
ExportIaCConfig
Configuration for exporting a resource as IAC.
| Fields | |
|---|---|
iac_format |
Optional. IaC format of the export. Default is [IACFormat.TERRAFORM]. |
Union field config_payload. Configuration for the export based on the IaC format. config_payload can be only one of the following: |
|
tf_config |
Optional. Configuration on how to handle terraform IaC export. |
FetchApplicationAssessmentReportRequest
Message for fetching an application assessment report.
| Fields | |
|---|---|
name |
Required. The application name in the following format: |
FetchApplicationAssessmentReportResponse
Message for response of fetching an application assessment report.
| Fields | |
|---|---|
assessment_report |
Assessment report for the application. |
FetchApplicationRequest
Request message for FetchApplication.
| Fields | |
|---|---|
parent |
Required. The parent resource. Format: projects/{project}/locations/{location} |
apphub_application |
Required. Full name of the AppHub application. Format: |
FetchApplicationResponse
Response message for FetchApplication
| Fields | |
|---|---|
application |
The application having given Apphub ID. |
FetchCatalogTemplateRevisionTFSourceRequest
Request message for fetching the Terraform source of a catalog template revision.
| Fields | |
|---|---|
name |
Required. Name of the resource Eg: |
FetchCatalogTemplateRevisionTFSourceResponse
Response message for getting the Terraform source of a catalog template revision.
| Fields | |
|---|---|
root_module |
The root Terraform module of the catalog template revision. |
modules[] |
The dependent Terraform modules used by the root module. |
FetchFrameworksRequest
Request for FetchFrameworks rpc
| Fields | |
|---|---|
parent |
Required. The parent resource name. Format: projects/{project}/locations/{location} |
projects[] |
Optional. Projects to fetch frameworks for. Format: projects/{project} |
page_size |
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 |
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 |
Optional. Filter for frameworks list. |
FetchFrameworksResponse
Response for FetchFrameworks rpc
| Fields | |
|---|---|
frameworks[] |
The list of frameworks. |
next_page_token |
A token, which can be sent as |
Framework
Framework for assessment.
| Fields | |
|---|---|
name |
Required. The framework name. |
major_revision_id |
Optional. The major revision id of the framework. |
parent_domain |
Required. The domain to which this framework belongs. |
display_name |
Optional. The framework display name. |
description |
Optional. The framework description. |
url |
Optional. The URL to a framework. |
active |
Optional. Whether the framework is active. |
cloud_control_details[] |
Optional. The cloud controls that are associated with the framework. |
deployment_status |
Optional. The deployment status of the framework. |
DeploymentStatus
Enum for deployment status of a framework.
| Enums | |
|---|---|
DEPLOYMENT_STATUS_UNSPECIFIED |
Deployment status unspecified. |
DEPLOYED |
Framework is deployed. |
UNDEPLOYED |
Framework is undeployed. |
GKEDeploymentTarget
The GKE deployment target.
| Fields | |
|---|---|
cluster_self_link |
Required. The self link of the cluster where GKE based application is deployed. |
namespace |
Required. The namespace where the application is deployed. |
kubernetes_service_account |
Required. The kubernetes service account that is created within the namespace provided above. Example: default or node-sa |
kubernetes_service_account_creation |
Optional. Whether to create the provided KSA. If true, the KSA will be created in the namespace provided above. If false, the KSA is expected to already exist in the namespace provided above. |
GenerateApplicationIaCRequest
Request message for GenerateApplicationIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application. |
iac_format |
Optional. The IaC format to generate. |
gcs_uri |
Optional. The Cloud Storage URI to write the generated IaC to. DEPRECATED: Use the 'artifact_location' field instead. |
artifact_location |
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 |
The Cloud Storage URI of the generated IaC. DEPRECATED: Use the 'artifact_location' field instead. |
artifact_location |
The destination where the generated IaC was written. |
root_modules_metadata |
Root modules metadata of the application. |
GenerateApplicationTemplateAssessmentReportRequest
Message for generate assessment report application template.
| Fields | |
|---|---|
name |
Required. The application template name in the following format: |
service_account |
Optional. The email address of the service account to use for this preview operation.
|
GenerateApplicationTemplateAssessmentReportResponse
Response for GenerateAssessmentReport for application template.
| Fields | |
|---|---|
preview |
Infrastructure Manager preview. |
assessment_report |
Best practices by Design Assessment report |
GenerateApplicationTemplateIaCRequest
Request message for GenerateApplicationTemplateIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application template. |
iac_format |
Optional. The IaC format to generate. |
gcs_uri |
Optional. The Cloud Storage URI to write the generated IaC to. DEPRECATED: Use the 'artifact_location' field instead. |
artifact_location |
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 |
The Cloud Storage URI of the generated IaC. DEPRECATED: Use the 'artifact_location' field instead. |
artifact_location |
The destination where the generated IaC was written. |
root_modules_metadata |
Root modules metadata of the application template. |
GenerateApplicationTemplateRevisionIaCRequest
Request message for GenerateApplicationTemplateRevisionIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application template revision. |
iac_format |
Optional. The IaC format to generate. |
artifact_location |
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. |
GenerateApplicationTemplateRevisionIaCResponse
Response message for GenerateApplicationTemplateRevisionIaC method.
| Fields | |
|---|---|
artifact_location |
The destination where the generated IaC was written. |
root_modules_metadata |
Root modules metadata of the application template revision. |
GenerateAssessmentReportRequest
Message for the request to generate a best practice report for a given Terraform plan.
| Fields | |
|---|---|
terraform_plan |
Required. Terraform plan bytes. |
additional_frameworks[] |
Optional. Additional Frameworks to run assessment against. If empty, run against default frameworks. Frameworks refers to the policies. |
space_name |
Required. The name of the space at which Generate Assessment Report is called. Format: |
GenerateAssessmentReportResponse
Response for GenerateAssessmentReport.
| Fields | |
|---|---|
assessment_report |
Aggregated assessment report from all domains. |
GetApplicationRequest
Message for getting an application.
| Fields | |
|---|---|
name |
Required. The application name. Format: |
GetApplicationTemplateRequest
Message for getting an application template.
| Fields | |
|---|---|
name |
Required. The application template name. |
GetApplicationTemplateRevisionRequest
Message for getting an application template revision.
| Fields | |
|---|---|
name |
Required. The application template revision name. |
GetApplicationTemplateSystemRevisionRequest
Message for getting an ApplicationTemplateSystemRevision.
| Fields | |
|---|---|
name |
Required. The name of the ApplicationTemplateSystemRevision to retrieve. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template}/systemRevisions/{system_revision} |
GetCatalogRequest
Message for getting a catalog.
| Fields | |
|---|---|
name |
Required. The catalog name in the following format: |
GetCatalogTemplateRequest
Message for getting a catalog template resource.
| Fields | |
|---|---|
name |
Required. The catalog template name in the following format: |
GetCatalogTemplateRevisionRequest
Message for GetTemplateRevision Request
| Fields | |
|---|---|
name |
Required. The catalog template revisions name. |
GetComponentRequest
Message for getting a component.
| Fields | |
|---|---|
name |
Required. The component name. |
GetConnectionRequest
Message for getting a connection.
| Fields | |
|---|---|
name |
Required. Name of the resource |
GetPolicyRequest
Message for getting a policy.
| Fields | |
|---|---|
name |
Required. The policy name in the following format: |
GetSpaceRequest
Results returned from projects.locations.spaces.get.
| Fields | |
|---|---|
name |
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 |
Optional. The name of the branch from which content should be read. For example: "main" |
ref_tag |
Optional. The reference tag from which content should be read. For example: "v1.2.3" |
commit_sha |
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 |
Required. Location of the git repo to build. |
dir |
Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's |
commit_sha |
Output only. The commit SHA of the git repo deduced from given ref_tag. |
developer_connect_config |
Optional. This config defines the location of a source through Developer Connect. Used to access private git repos. |
ref_tag |
Required. The reference tag of the git repo. |
HelmApplicationOutputParameters
The helm application output parameters of the deployment.
| Fields | |
|---|---|
parameters[] |
Output only. The output parameters of the helm application. |
HelmChartInput
Helm Chart inputs. Documentation: https://helm.sh/docs/
| Fields | |
|---|---|
helm_input_variable |
Output only. Input variable name present in Helm Chart values.yaml |
description |
Output only. Input variable description. |
type |
Output only. Input data type. |
default_value |
Output only. The default value of the input variable. |
is_required |
Output only. Indicates if input is required. |
nested_inputs |
Output only. Contains details of nested inputs. |
HelmChartMetadata
Helm Chart metadata.
| Fields | |
|---|---|
helm_input[] |
Output only. Helm Chart inputs. |
helm_output[] |
Output only. Helm Chart outputs. |
HelmChartOutput
Helm Chart outputs.
| Fields | |
|---|---|
value |
Output only. Type of output. |
helm_output_variable |
Output only. Output variable name present. |
description |
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. |
IaCFile
IaCFile represents a single infrastructure as code file.
| Fields | |
|---|---|
name |
Required. The name of the file. |
content |
Optional. The content of the file. The content of the file can be read and passed as a string. For example, for a terraform file, the content is the the HCL content of the file. |
IaCModule
IaCModule represents a single infrastructure as code module.
| Fields | |
|---|---|
files[] |
Optional. The files in the module. |
IacFormatInfo
IacFormatInfo defines the actuation tool used to provision the Template.
| Fields | |
|---|---|
flavor |
Required. Flavor is the type of the actuation tool. |
version |
Required. Required version for the actuation tool. required_version = ">= 0.13" |
ImportApplicationIaCRequest
Request message for ImportApplicationIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application. |
allow_partial_import |
Optional. If set to true, partially imports the valid edits in the IaC and ignores the invalid changes. Defaults to false, which means any edits which can't be imported must result in an error. |
validate_iac |
Optional. If set to true, the IaC is validated against the golden terraform without importing. Defaults to false. |
Union field source. The source location of terraform code. source can be only one of the following: |
|
gcs_uri |
Optional. The Cloud Storage URI of the terraform code. |
iac_module |
Optional. The IaC module to import. |
ImportApplicationIaCResponse
Response message for ImportApplicationIaC method.
| Fields | |
|---|---|
application |
Application template corresponding to the imported IaC. |
errors[] |
Errors encountered during import. |
state |
The state of the import. |
State
State of Import.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default. |
SUCCEEDED |
The import was successful. |
FAILED |
The import failed. |
ImportApplicationTemplateIaCRequest
Request message for ImportApplicationTemplateIaC method.
| Fields | |
|---|---|
name |
Required. The name of the application template. |
allow_partial_import |
Optional. If set to true, partially imports the valid edits in the IaC and ignores the invalid changes. Defaults to false, which means any edits which can't be imported must result in an error. |
validate_iac |
Optional. If set to true, the IaC is validated against the golden terraform without importing. Defaults to false. |
Union field source. The source location of terraform code. source can be only one of the following: |
|
gcs_uri |
Optional. The Cloud Storage URI of the terraform code. |
iac_module |
Optional. The IaC module to import. |
developer_connect_source_config |
Optional. Configuration for fetching content from source code repository such as GitHub or Bitbucket through Developer Connect. |
ImportApplicationTemplateIaCResponse
Response message for ImportApplicationTemplateIaC method.
| Fields | |
|---|---|
application_template |
Application template corresponding to the imported IaC. |
errors[] |
Errors encountered during import. |
state |
The state of the import. |
State
State of Import.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Default. |
SUCCEEDED |
The import was successful. |
FAILED |
The import failed. |
ImportApplicationTemplateRequest
Request message for ImportApplicationTemplate method.
| Fields | |
|---|---|
name |
Required. The name of the application template. |
annotations |
Optional. Annotations to be stored with the new system revision created as a result of this import. Sample annotations from agentic workflows might look like { "designcenter.googleapis.com/agent_id": "gemini-3-flash-v1", "designcenter.googleapis.com/llm_agent_summary": "Restored to revision Rev-100", "designcenter.googleapis.com/external_ref_id": "trace-uuid-88921-xyz", } |
Union field source. The source for setting application template components/connections. source can be only one of the following: |
|
application_template_revision_uri |
Optional. The source URI for application template revision. |
shared_template_revision_uri |
Optional. The source URI for catalog template. |
serialized_application_template |
Optional. The serialized application template to be imported. |
application_template_system_revision |
Optional. The system revision to be imported. Used when user tries to Restore (rev X) or perform Undo/Redo operations. |
ImportIaCError
Message representing the error encountered during import. Example: A variable with name "name" is expected to be of type string, but is provided as number, inside a module named "my_module". { resource_address: "module.my_module.name" file: "gs://my_bucket/main.tf" range: { start: { line: 2 byte_offset: 1 column: 2 } end: { line: 2 byte_offset: 10 column: 10 } } description: "Error parsing field: "name". Expected type "string" but got "number"." type: INVALID }
| Fields | |
|---|---|
resource_address |
Output only. The resource address of the error. |
file |
Output only. The file where the error has occurred. |
range |
Output only. The code portion where this error occurs. |
description |
Output only. The description of the error. |
type |
Output only. The type of error. |
Type
The type of error.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Default. |
INVALID |
The change is invalid. Example: a string value provided for a number input parameter type, which would be caught by terraform validation. |
NOT_SUPPORTED |
The change is not supported. Example: a user directly adding a Terraform resource in main.tf that Design Center does not support importing. |
ImportSerializedApplicationTemplateRequest
Request message for ImportSerializedApplicationTemplate.
| Fields | |
|---|---|
name |
Required. The name of the application template. |
serialized_application_template |
Required. The serialized application template to be imported. |
InferConnectionsRequest
Request message for InferConnections method.
| Fields | |
|---|---|
name |
Required. The name of the space. |
catalog_template_revision_uris[] |
Optional. A list of Catalog template revisions that you want to infer connections for. If you don't provide this, the system infers connections for the latest revisions of all catalog templates in all the catalogs present in the space. |
use_gemini |
Optional. Whether to use Gemini. |
InferConnectionsResponse
Response message for InferConnections method.
| Fields | |
|---|---|
suggested_catalog_template_revisions[] |
List of components containing inferred connections. |
InferredMetadata
Inferred metadata.
| Fields | |
|---|---|
description |
Output only. Inferred description. |
template_metadata |
Output only. Inferred template metadata related to Terraform input and output. |
create_time |
Output only. Inferred metadata creation timestamp. |
update_time |
Output only. Inferred metadata update timestamp. |
ListApplicationTemplateRevisionsRequest
Message for requesting a list of application template revisions.
| Fields | |
|---|---|
parent |
Required. The parent from which to list application template revisions. |
page_size |
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 |
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 |
Optional. A filter that chooses which application template revisions to return. |
order_by |
Optional. How the results should be sorted. |
ListApplicationTemplateRevisionsResponse
Message for response to listing application template revisions.
| Fields | |
|---|---|
application_template_revisions[] |
The list of application template revisions. |
next_page_token |
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[] |
Locations that could not be reached. |
ListApplicationTemplateSystemRevisionsRequest
Message for requesting a list of application template system revisions.
| Fields | |
|---|---|
parent |
Required. The parent Application Template from which to list the system revisions. Format: projects/{project}/locations/{location}/spaces/{space}/applicationTemplates/{application_template} |
page_size |
Optional. The maximum number of system revisions to return. The service may return fewer than this value. If unspecified, at most 50 system revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
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 |
Optional. A filter expression that filters system revisions listed in the response. See https://google.aip.dev/160 for more information on the grammar. |
ListApplicationTemplateSystemRevisionsResponse
Message for response to listing application template system revisions.
| Fields | |
|---|---|
application_template_system_revisions[] |
The list of application template system revisions. |
next_page_token |
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[] |
Unordered list. Locations that could not be reached. |
ListApplicationTemplatesRequest
Message for requesting a list of application templates.
| Fields | |
|---|---|
parent |
Required. The parent resource from which to list application templates. |
page_size |
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 |
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 |
Optional. A filter that chooses which shared template revisions to return. |
order_by |
Optional. How the results should be sorted. |
ListApplicationTemplatesResponse
Message for response to listing application templates.
| Fields | |
|---|---|
application_templates[] |
The list of application templates. |
next_page_token |
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[] |
Locations that could not be reached. |
ListApplicationsRequest
Message for requesting a list of applications.
| Fields | |
|---|---|
parent |
Required. The parent resource from which to request a list of applications. |
page_size |
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 |
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 |
Optional. A filter that chooses which applications to return. |
order_by |
Optional. How the results should be sorted. |
ListApplicationsResponse
Message for response to listing applications.
| Fields | |
|---|---|
applications[] |
The list of applications. |
next_page_token |
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[] |
Unordered list. Locations that could not be reached. |
ListCatalogTemplateRevisionsRequest
Message for requesting list of template revisions.
| Fields | |
|---|---|
parent |
Required. The parent resource from which a list of catalog template revisions is requested. |
page_size |
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 |
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 |
Optional. A filter that chooses which catalog template revisions to return. |
order_by |
Optional. How the results should be sorted. |
ListCatalogTemplateRevisionsResponse
Message for response to listing template revisions.
| Fields | |
|---|---|
catalog_template_revisions[] |
The list of template revisions. |
next_page_token |
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[] |
Locations that could not be reached. |
ListCatalogTemplatesRequest
Message for requesting a list of catalog templates.
| Fields | |
|---|---|
parent |
Required. The parent from which the catalog templates are listed in the following format: |
page_size |
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 |
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 |
Optional. A filter that chooses the catalog templates to return. |
order_by |
Optional. How the results should be sorted. |
ListCatalogTemplatesResponse
Message for response to listing catalog templates.
| Fields | |
|---|---|
catalog_templates[] |
The list of catalog templates. |
next_page_token |
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 |
Required. The parent space from which catalogs are listed. Format: |
page_size |
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 |
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 |
Optional. A filter that chooses which catalogs to return. |
order_by |
Optional. How the results should be sorted. |
ListCatalogsResponse
Results returned from catalogs.list.
| Fields | |
|---|---|
catalogs[] |
A list of catalogs |
next_page_token |
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 |
Required. The parent resource from which the list of components is requested. |
page_size |
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 |
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 |
Optional. A filter that chooses which components to return. |
order_by |
Optional. How the results should be sorted. |
ListComponentsResponse
Message for response to listing components.
| Fields | |
|---|---|
components[] |
The list of components. |
next_page_token |
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[] |
Locations that could not be reached. |
ListConnectionsRequest
Message for requesting a list of connections.
| Fields | |
|---|---|
parent |
Required. The parent resource from which to request a list of connections. |
page_size |
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 |
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 |
Optional. A filter that chooses which connections to return. |
order_by |
Optional. How the results should be sorted. |
ListConnectionsResponse
Message for response to listing connections.
| Fields | |
|---|---|
connections[] |
The list of connections. |
next_page_token |
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[] |
Locations that could not be reached. |
ListPoliciesRequest
Message for requesting a list of policies.
| Fields | |
|---|---|
parent |
Required. The parent application template from which policies are listed in the following format: |
page_size |
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 |
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 |
Optional. A filter that chooses which policies to return. |
order_by |
Optional. How the results should be sorted. |
ListPoliciesResponse
Message for response to listing policies.
| Fields | |
|---|---|
policies[] |
A list of policies. |
next_page_token |
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 |
Required. The name of the parent resource, for which spaces are listed. |
page_size |
Optional. The maximum number of pages to return from this request. If unspecified, the value automatically reflects the number of results returned. |
page_token |
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 |
Optional. A filter that chooses which spaces to return. |
order_by |
Optional. How the results are sorted. |
ListSpacesResponse
Results returned from projects.locations.spaces.list.
| Fields | |
|---|---|
spaces[] |
A list of spaces. |
next_page_token |
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[] |
Unordered list. Locations that could not be reached. |
LogicalProduct
Represents a Product Main logical product.
| Fields | |
|---|---|
name |
Output only. The resource name of the logical product. Format: logicalProducts/{logical_product} |
title |
Output only. The display name of the logical product. |
short_description |
Output only. A short description of the logical product. |
ManageApplicationRequest
Request message for ManageApplication. This request is used by an agent via an MCP tool to perform operations on application resources. The agent should populate fields based on the operation being performed.
| Fields | |
|---|---|
parent |
Required. The parent resource. Format: projects/{project}/locations/{location}/spaces/{space} |
application_id |
Required. The ID of application. For APPLICATION_CREATE, this is the ID of application to create. For other operations like UPDATE, PREVIEW, DEPLOY, this is used to identify the application. |
application |
Optional. The application resource. Required for APPLICATION_CREATE and APPLICATION_UPDATE operations. |
update_mask |
Optional. Field mask for APPLICATION_UPDATE operation. |
service_account |
Optional. The service account for APPLICATION_PREVIEW or APPLICATION_DEPLOY operations. Format: projects/{PROJECT}/serviceAccounts/{EMAIL_ADDRESS} If a service account is provided, the system will attempt to grant it the necessary roles. The caller must have the |
operation |
Required. The operation to perform on the application. |
artifact_location |
Optional. The location of the artifact for the application. Required for APPLICATION_GENERATE_IAC operation. |
application_template_uri |
Optional. The URI of the application template. Required for creating an application from an application template. |
application_template_revision_uri |
Optional. The URI of the application template revision. Required for creating an application from an application template revision. |
deployment_region |
Optional. The deployment region of the application. Required for creating an application during deployment. |
ManageApplicationResponse
Response message for ManageApplication. This response is used by an agent via an MCP tool to return the result of operations on application resources.
| Fields | |
|---|---|
Union field payload. The response payload, holding one of the possible results (application, preview_response, or deploy_response) of the operation performed on the application resource. This field is consumed by an agent via an MCP tool to inform the user about the result of the payload can be only one of the following: |
|
application |
Contains the application resource that was created or updated. This field is populated when the original request was for a get, create or update operation. |
generate_iac_response |
Contains the result of a generate iac operation. This response includes details about the generated IaC, such as its location. |
operation_response |
Contains the result of an application operation. |
ManageApplicationTemplateRequest
Request message for ManageApplicationTemplate. This request is used by an agent via an MCP tool to perform operations on application template resources. The agent should populate fields based on the operation being performed.
| Fields | |
|---|---|
parent |
Required. The parent resource. Format: projects/{project}/locations/{location}/spaces/{space} |
application_template_id |
Required. The ID of application template. For APPLICATION_TEMPLATE_CREATE, this is the ID of application template to create. For other operations like UPDATE, COMMIT, GENERATE_IAC, this is used to identify the application template. |
application_template |
Optional. The application template resource. Required for APPLICATION_TEMPLATE_CREATE and APPLICATION_TEMPLATE_UPDATE operations. |
update_mask |
Optional. Field mask for APPLICATION_TEMPLATE_UPDATE operation. |
operation |
Required. The operation to perform on the application template. |
iac_module |
Optional. The IaC module to import. |
component_parameters[] |
Optional. The component parameters to import. |
artifact_location |
Optional. Specifies the location of the artifact for the application template. Used for |
ManageApplicationTemplateResponse
Response message for ManageApplicationTemplate.
| Fields | |
|---|---|
Union field payload. The response payload. payload can be only one of the following: |
|
application_template |
Contains the application template resource that was created or updated. This field is populated when the original request was for a get, create or update operation. |
application_template_revision |
Contains the result of a commit operation. This response details the application template revision that was created. |
generate_iac_response |
Contains the result of a generate IaC operation. This response includes details about the generated IaC, such as its location. |
import_iac_response |
Contains the result of an import IaC operation. This response includes details about the imported IaC, such as its location. |
MetadataInput
Metadata for the input
| Fields | |
|---|---|
spec |
Required. spec containing the metadata |
MetadataInputSpec
Specifications for the input
| Fields | |
|---|---|
info |
Optional. TemplateInfo provides the actuation tool information. |
interfaces |
Optional. TemplateSchemas provides the input variables lists and connection information. |
requirements |
Required. TemplateRequirements defines the roles required and the provider versions. |
ui |
Optional. TemplateUi defines the UI related information for the Template. |
OciRepo
Open Container Initiative (OCI) repo.
| Fields | |
|---|---|
uri |
Required. Path to Open Container Initiative (OCI) repo. Example: oci://us-west1-docker.pkg.dev/nyap-test/helm-repo/my-chart |
version |
Optional. The version of the helm chart. |
OperationMetadata
Represents the metadata of the long-running operation.
| Fields | |
|---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. The server defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a |
api_version |
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 |
Output only. The application deployment metadata this operation is associated with. |
preview_metadata |
Output only. The application preview metadata this operation is associated with. |
application_metadata |
Output only. The application delete metadata this operation is associated with. |
deployment_group_metadata |
Output only. The Provision Deployment Group Metadata this operation is associated with. |
Parameter
Parameter resource.
| Fields | |
|---|---|
key |
Required. The key of the parameter. |
value |
Optional. The value of the parameter. |
Policy
A Policy is a resource within an Application Template that refers to a Policy that you author outside of Application Design Center and attach to an application template.
| Fields | |
|---|---|
name |
Identifier. The policy name in the following format: |
display_name |
Optional. The policy display name. |
description |
Optional. The policy description. |
policy_type |
Required. The policy type. Policy type is used to determine the domain of the policy. |
apply_conditions[] |
Optional. Conditions for applying the policy. Condition accepts the |
create_time |
Output only. The policy creation timestamp. |
update_time |
Output only. The policy update timestamp. |
Union field uri. URI of the policy or the policy revision. uri can be only one of the following: |
|
policy_uri |
Optional. URI of the policy. |
policy_revision_uri |
Optional. URI of the policy revision. |
ApplyCondition
Condition for applying the policy. Accepts the criticality and environment parameters from the AppTemplate.
| Fields | |
|---|---|
condition_key |
Required. The key of the parameter for the condition. |
condition_value |
Required. The value of the parameter for the condition. |
PolicyType
The policy type.
| Enums | |
|---|---|
POLICY_TYPE_UNSPECIFIED |
Default. |
COMPLIANCE_FRAMEWORK |
Compliance framework policy. |
PreviewApplicationRequest
Message for deploying an application.
| Fields | |
|---|---|
name |
Required. The application name in the following format: |
worker_pool |
Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} If this flag is omitted, the worker pool already defined on the application will be used. If no worker pool is defined on the application, the default Cloud Build worker pool is used. The worker pool must exist in the same region as the application. |
service_account |
Optional. The email address of the service account to use for this preview operation.
|
PreviewApplicationResponse
Response for PreviewApplication.
| Fields | |
|---|---|
preview |
Infrastructure Manager preview. |
assessment_report |
Best practices by Design Assessment report |
PreviewOperationMetadata
Ephemeral metadata depicting the state of the preview operation.
| Fields | |
|---|---|
preview_step |
Output only. The current step of the preview. The possible steps a preview may be running as returned by the Infrastructure. Manager. |
preview_build |
Output only. Cloud Build instance UUID associated with the preview operation. |
preview_logs |
Output only. Location of the preview operation logs in |
resources[] |
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 |
Output only. The project ID of the project. |
roles[] |
Output only. IAM roles required by the service account to deploy the application in given project. |
apis[] |
Output only. APIs required to be enabled to deploy the application, in the form of "*.googleapis.com". |
ProjectParametersList
Provides the list of project parameters needed to deploy an application.
| Fields | |
|---|---|
project_parameters[] |
Output only. List of project parameters for the application. |
ProviderVersion
ProviderVersion defines the required version for a provider.
| Fields | |
|---|---|
source |
Output only. The provider source in the format: [hostname]/[namespace]/[name]. Hostname is optional, and defaults to the Terraform registry. |
version |
Output only. Version constraint string. |
ProvisionDeploymentGroupOperationMetadata
Represents the Provision Deployment Group operation metadata.
| Fields | |
|---|---|
deployment_step |
Output only. Current step of deploying composite application |
deployment_unit_progress[] |
Output only. List of deployment unit deployment progress |
DeploymentStep
Current Deployment Operation Step
| Enums | |
|---|---|
DEPLOYMENT_STEP_UNSPECIFIED |
Unspecified deployment step. |
GENERATING_TERRAFORM_CONTENT |
Generating Terraform content for the application. |
DEPLOYING |
Deploying the application. |
SUCCEEDED |
Operation was successful. |
FAILED |
Operation failed. |
RegisterAppHubApplicationResourcesRequest
Request message for RegisterAppHubApplicationResources method.
| Fields | |
|---|---|
parent |
Required. The parent location. Format: projects/{project}/locations/{location} |
apphub_application |
Required. The name of the AppHub Application. Format: projects/{project}/locations/{location}/applications/{application} |
Union field tfstate_source. The Terraform state (tfstate) source. tfstate_source can be only one of the following: |
|
tfstate_content |
Optional. The Terraform state (tfstate) content as a raw string. For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri' field instead. |
tfstate_signed_gcs_uri |
Optional. A securely signed Cloud Storage URI pointing to the tfstate file. The URI must be signed to grant the service temporary read access to the state file. Application Design Center imposes a limit on the maximum size of the state file accessed via this URI. |
RegisterAppHubApplicationResourcesResponse
Response message for RegisterAppHubApplicationResources method.
| Fields | |
|---|---|
response |
The response for the registration of deployed resources of a given AppHub application. |
RegisterApphubResourcesRequest
Request message for RegisterApphubResources method.
| Fields | |
|---|---|
parent |
Required. The parent space. Format: projects/{project}/locations/{location}/spaces/{space} |
deployed_resources[] |
Optional. The list of deployed GCP resources to register. |
Union field application_identifier. The application identifier. application_identifier can be only one of the following: |
|
adc_application_uri |
The resource uri of the Application. Used for registering resources of an application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application} |
apphub_application_uri |
The resource uri of the App Hub application. Used for registering resources of an application template. Format: projects/{project}/locations/{location}/applications/{application} |
RegisterApphubResourcesResponse
Response message for RegisterApphubResources method.
| Fields | |
|---|---|
apphub_application_uri |
The App Hub application name. |
registered_resources[] |
The list of successfully registered GCP resources. |
unregistered_resources[] |
The list of unregistered GCP resources with error details. |
RegisterDeployedApplicationRequest
Request message for RegisterDeployedApplication method.
| Fields | |
|---|---|
name |
Required. The name of the application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application} |
service_account |
Optional. The optional Service Account (SA) to use for calling AppHub APIs during registration. If not provided, the End-User Credentials (EUC) will be used. If provided, the EUC must have the 'serviceAccountTokenCreator' role on the SA, and the SA must have the necessary permissions for AppHub registration. |
Union field tfstate_source. The Terraform state (tfstate) source. tfstate_source can be only one of the following: |
|
terraform_state |
The Terraform state (tfstate) content as a raw string. For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri' field instead. |
tfstate_signed_gcs_uri |
A securely signed Cloud Storage URI pointing to the tfstate file. The URI must be signed to grant the service temporary read access to the state file. Application Design Center imposes a limit on the maximum size of the state file accessed via this URI. |
RegisterDeployedApplicationResponse
Response message for RegisterDeployedApplication method.
| Fields | |
|---|---|
response |
The response for the registration of deployed resources for a deployed application. |
RegisterDeployedResourcesRequest
Request message for RegisterDeployedResources method.
| Fields | |
|---|---|
parent |
Required. The parent space. Format: projects/{project}/locations/{location}/spaces/{space} |
apphub_application |
Required. The name of the AppHub Application. Format: projects/{project}/locations/{location}/applications/{application} |
service_account |
Optional. The optional Service Account (SA) to use for calling AppHub APIs during registration. If not provided, the End-User Credentials (EUC) will be used. If provided, the EUC must have the 'serviceAccountTokenCreator' role on the SA, and the SA must have the necessary permissions for AppHub registration. |
Union field tfstate_source. The Terraform state (tfstate) source. tfstate_source can be only one of the following: |
|
terraform_state |
The Terraform state (tfstate) content as a raw string. For large state files exceeding 10MB, use the 'tfstate_signed_gcs_uri' field instead. |
tfstate_signed_gcs_uri |
A securely signed Cloud Storage URI pointing to the tfstate file. The URI must be signed to grant the service temporary read access to the state file. Application Design Center imposes a limit on the maximum size of the state file accessed via this URI. |
RegisterDeployedResourcesResponse
Response message for RegisterDeployedResources method.
| Fields | |
|---|---|
response |
The response for the registration of deployed resources of a given AppHub application. |
RemediationStep
Remediation steps that can be taken to rectify the finding.
| Fields | |
|---|---|
remediation_steps[] |
Required. A description of the steps that users can take to remediate the findings. |
remediation_documentation_url |
Optional. Remediation documentation URL. |
note |
Optional. Any other note related to the remediation. |
Resource
Status of the [Resources][]s in the deployment.
| Fields | |
|---|---|
name |
Output only. Identifier. The name of the resource. |
type |
Output only. The type of the resource. |
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. |
ResourceType
Represents the type of a resource within a component template.
| Fields | |
|---|---|
tf_resource |
Output only. The Terraform resource type. For example: "google_compute_instance". |
cais_resource |
Output only. The CAIS resource type. |
RootInputVariable
Input variable of a root module.
| Fields | |
|---|---|
variable |
Name of the input variable. |
variable_type |
Type of the input variable. |
value |
Value for the input variable. |
default_value |
Default value of the input variable. |
RootModule
Metadata for a root module.
| Fields | |
|---|---|
id |
Identifier of the root module. This is the directory name of the root module in the generated terraform which is also same as the corresponding component ID. |
components[] |
List of Application Design Center component names associated with this root module. For standard app template type components, this list will have a single element. For service / workload / asset components, this list will contain all such component names. |
dependencies[] |
Dependencies of this root module. The dependency graph of root modules must be acyclic. |
input_variables[] |
List of input variables of this root module. |
output_variables[] |
List of output variables of this root module. |
RootModuleDependency
Root module dependency.
| Fields | |
|---|---|
root_module_id |
Identifier of the root module. |
parameters[] |
Parameters associated with this dependency. |
RootModulesMetadata
Root modules metadata.
| Fields | |
|---|---|
root_modules[] |
List of terraform root modules. |
RootOutputVariable
Output variable of a root module.
| Fields | |
|---|---|
variable |
Name of the output variable. |
SCCMetadata
SCC metadata for the assessment finding.
| Fields | |
|---|---|
finding_class |
Optional. The SCC finding class. Also known as category. |
finding_type |
Optional. The SCC finding type. |
SaaSRuntimeContext
SaaS runtime context.
| Fields | |
|---|---|
saas_names[] |
Optional. The SaaS names. Format for each SaaS: projects/{project}/locations/{location}/saas/{saas} |
ScoreCard
Score card associated with the report.
| Fields | |
|---|---|
report_score |
Required. Calculated score of the report. |
max_score |
Required. Maximum score of the report. For example, for a score of 75/100, report_score is 75 and max_score is 100. |
min_score_required |
Optional. Minimum score required to pass assessment. |
average_score |
Optional. Average score for similar reports. |
SerializedApplicationTemplate
Serialized application template.
| Fields | |
|---|---|
uri |
Optional. The application template URI. |
display_name |
Optional. The application template display name. |
description |
Optional. The application template description. |
application_parameters[] |
Optional. Parameters to apply to all components in the application template. |
iac_format |
Optional. The IaC format of the application template. |
components[] |
Optional. The application template components. |
apphub_application_parameters |
Optional. The App Hub application parameters. |
has_global_resource |
Output only. Whether the application template is compatible with regional scope. |
composition_type |
Output only. The composition type of the applicationTemplate: STANDARD OR COMPOSITE. |
root_input_variables[] |
Output only. Root level input variables of the application template. |
root_output_variables[] |
Output only. Root level output variables of the application template. |
saas_runtime_context |
Optional. SaaS runtime context for the application template. |
SerializedComponent
Serialized component.
| Fields | |
|---|---|
uri |
Optional. The component URI. |
shared_template_revision_uri |
Optional. The shared template used to generate the component. |
parameters[] |
Optional. The component parameters. |
connections[] |
Optional. The component connections. |
roles[] |
Optional. IAM roles required by the service account to deploy the component. |
apis[] |
Optional. APIs required to be enabled to deploy the component, in the form of "*.googleapis.com". |
display_name |
Optional. The component display name. |
connections_parameters[] |
Output only. The connection parameters of the component. |
component_parameter_schema[] |
Output only. The component parameter schema, which includes possible parameter values. |
application_info |
Optional. The application associated with the component. |
SerializedConnection
Serialized connection.
| Fields | |
|---|---|
uri |
Optional. The connection URI. |
destination_component_uri |
Optional. The destination component URI used to generate the connection. |
source_component_parameters[] |
Optional. The parameters of the connection associated with the source component. |
destination_component_parameters[] |
Optional. The parameters of the connection associated with the destination component. |
SetupADCRequest
Request message for SetupADC.
| Fields | |
|---|---|
parent |
Required. The parent resource name of the location. |
space_id |
Required. The ID of space to create. |
SetupADCResponse
Response message for SetupADC.
| Fields | |
|---|---|
space |
The space that was created or already existed. Format: projects/{project}/locations/{location}/spaces/{space} |
catalog |
The catalog that was created or already existed. Format: projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog} |
share |
The share that was created or already existed. Format: projects/{project}/locations/{location}/spaces/{space}/catalogs/{catalog}/shares/{share} |
SkippedDomain
Domains skipped during the best practice assessment.
| Fields | |
|---|---|
domain |
Output only. Details of the domain skipped. |
skip_reason |
Output only. Reason for skipping the domain from assessment. |
Reason
Reason for skipping the domain from assessment.
| Enums | |
|---|---|
REASON_UNSPECIFIED |
No reason specified. |
UNAVAILABLE |
Domain is unavailable. |
FAILURE |
Domain assessment failed. |
TIMEOUT |
Domain assessment timed out. |
Space
Space is a top level resource for managing teams building applications through Application Design Center.
| Fields | |
|---|---|
name |
Identifier. The space name. |
display_name |
Optional. Display name for the space. |
description |
Optional. Description for the space. |
create_time |
Output only. Space creation timestamp. |
update_time |
Output only. Space update timestamp |
gcs_bucket |
Optional. An existing Google Cloud Storage bucket that you want to use instead of creating a new bucket during Application Design Center 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}. |
tags |
Optional. Input only. Immutable. Tags are key/values bound to space resource. Example: For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview. |
enable_gcp_shared_templates |
Optional. Flag to enable Google opinionated shared templates. |
TFBlueprintMetadata
Terraform input and output metadata.
| Fields | |
|---|---|
terraform_input[] |
Output only. Terraform inputs. |
terraform_output[] |
Output only. Terraform outputs. |
apis[] |
Output only. APIs that must be enabled to deploy the template, in the form of "compute.googleapis.com". |
roles[] |
Output only. IAM roles required by the service account deploying the template, in the form of "roles/compute.admin". |
deployment_duration |
Optional. The time estimate for deploying the blueprint. |
icon_uri |
Output only. The icon URI for the blueprint. |
connections[] |
Output only. Union of all the Terraform input connections. |
ui_metadata |
Output only. UI metadata for the blueprint. |
provider_versions[] |
Output only. Provider versions required to deploy the blueprint. |
TemplateCategory
Supported categories in Application Design Center.
| Enums | |
|---|---|
TEMPLATE_CATEGORY_UNSPECIFIED |
Unspecified category. |
COMPONENT_TEMPLATE |
Component template. |
APPLICATION_TEMPLATE |
Application template. |
COMPOSITE_SOLUTION_TEMPLATE |
Imported as a single, complex unit without disassembling into components. |
INSTANCE_TEMPLATE |
Instance template. |
TemplateConnections
TemplateConnections
| Fields | |
|---|---|
source |
Required. Source of the connection. |
spec |
Required. Connection specifications. |
TemplateInfo
TemplateInfo provides the actuation tool information.
| Fields | |
|---|---|
actuation_tool |
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[] |
Required. All roles required for the component |
provider_versions[] |
Required. Required provider versions. |
TemplateRoles
Template Roles provide the level and roles
| Fields | |
|---|---|
level |
Required. Level of the role. |
roles[] |
Required. List of roles. |
TemplateSchema
TemplateSchema provides the input variables lists and connection information.
| Fields | |
|---|---|
variables[] |
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. |
STANDARD_APPLICATION_TEMPLATE |
A standard application template. |
COMPOSITE_APPLICATION_TEMPLATE |
A composite application template. |
HELM_CHART |
A helm chart based template. |
TemplateUi
TemplateUi defines the UI related information for the Template.
| Fields | |
|---|---|
input |
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 |
Required. variables is a map defining all inputs on the UI. |
TemplateVariable
TemplateTerraform inputs.
| Fields | |
|---|---|
name |
Required. Input variable name present in Terraform. |
connections[] |
Required. Terraform input connections. |
TerraformBlueprintUiMetadata
Terraform blueprint UI metadata.
| Fields | |
|---|---|
terraform_ui_input |
Output only. Terraform UI inputs. |
terraform_ui_output |
Output only. Terraform UI outputs. |
TerraformConfig
Configuration for exporting a resource as Terraform IAC.
| Fields | |
|---|---|
tf_module_config |
Optional. Configuration on how terraform module should be handled during export. |
TerraformFile
Represents a single Terraform file.
| Fields | |
|---|---|
path |
The path of the Terraform file. |
content |
The content of the Terraform file. |
TerraformInput
Terraform inputs.
| Fields | |
|---|---|
terraform_input_variable |
Output only. Input variable name present in Terraform. |
description |
Output only. Terraform variable description. |
type |
Output only. The Terraform input data type. |
default_value |
Output only. The default value of the Terraform input variable. |
connections[] |
Output only. Terraform input connections. |
is_required |
Output only. Indicates if input is required. |
TerraformInputConnections
TerraformInputConnections
| Fields | |
|---|---|
cft_template_uri |
Output only. List of other templates that can be connected to. |
cft_template_version |
Output only. Version of the other template that can be connected to. |
output_var |
Output only. Output variable name present in Terraform. |
input_path |
Output only. Input path of the other template that can be connected to. |
TerraformModule
Represents a Terraform module, which is a collection of Terraform files. Eg: { "source": "git::https://github.com/my-org/my-repo", "files": [ { "path": "/path/to/file/main.tf", "content": "tf file content" } ] }
| Fields | |
|---|---|
source |
The source of the Terraform module. |
files[] |
The files within the Terraform module. |
TerraformModuleConfig
Configuration on how terraform module should be handled during export.
| Fields | |
|---|---|
Union field source_override. Specifies an override for the default module source handling. If no override is set, the default behavior is to keep the original module references. source_override can be only one of the following: |
|
git_proxy_enabled |
Optional. This is typically only valid for 3P components if ingested via devconnect URI. Typically, for 1P components, since they are sourced from public git repos, this field is not applicable. |
local_references_enabled |
Optional. If set, all the dependent modules will be downloaded from the target repository and referenced locally. |
TerraformOutput
Terraform outputs.
| Fields | |
|---|---|
type |
Output only. Type of Terraform output. |
terraform_output_variable |
Output only. Output variable name present in Terraform. |
description |
Output only. Description of the Terraform varaiable. |
TerraformUiInput
Terraform blueprint UI input.
| Fields | |
|---|---|
terraform_ui_inputs |
Output only. Terraform UI inputs. |
TerraformUiInputDisplayVariable
Terraform blueprint UI input display variable.
| Fields | |
|---|---|
display_name |
Output only. Display name of the input. |
title |
Output only. Title of the input. |
alternate_defaults[] |
Output only. Alternate defaults for the input. |
regex_validation |
Output only. Regex based validation rules for the variable. |
min |
Output only. Minimum value for numeric types. |
max |
Output only. Maximum value for numeric types. |
validation |
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[] |
Output only. Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters. |
level |
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 |
Output only. Property subtext, displayed below the title. |
toggle_using_variables[] |
Output only. Variables used to toggle the display of another variable. |
properties |
Output only. A map that defines all fields of the input variable. |
TerraformUiOutput
Terraform blueprint UI output.
| Fields | |
|---|---|
output_message |
Output only. Message to be displayed in the UI. |
terraform_ui_outputs |
Output only. Visibility of the output. |
TerraformUiOutputDisplay
Terraform blueprint UI output display.
| Fields | |
|---|---|
visibility |
Output only. Visibility of the output. |
UnregisteredResource
UnregisteredResource represents a GCP resource that failed to register and apphub was not able to discover.
| Fields | |
|---|---|
deployed_resource |
Output only. The deployed GCP resource that failed to register. |
reason |
Output only. The reason for the failure of registration. |
UpdateApplicationRequest
Message for updating an application.
| Fields | |
|---|---|
update_mask |
Optional. The fields to overwrite in the application update. If you don't provide a mask, all fields are overwritten. |
application |
Required. The application to update. |
UpdateApplicationTemplateRequest
Message for updating an application template.
| Fields | |
|---|---|
update_mask |
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 |
Required. The application template to update. |
UpdateCatalogRequest
Message for updating a catalog.
| Fields | |
|---|---|
update_mask |
Optional. The fields to overwrite in the catalog update. If you don't provide a mask, all fields are overwritten. |
catalog |
Required. The catalog to update. |
UpdateCatalogTemplateRequest
Message for updating a catalog template.
| Fields | |
|---|---|
catalog_template |
Required. The catalog template to update. Format: |
update_mask |
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 |
Optional. The fields to overwrite in the component update. If you don't provide a mask, all fields are overwritten. |
component |
Required. The component to update. |
UpdateConnectionRequest
Message for updating a connection.
| Fields | |
|---|---|
update_mask |
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 |
Required. The connection to update. |
UpdatePolicyRequest
Message for updating a policy.
| Fields | |
|---|---|
update_mask |
Optional. The fields to overwrite in the policy 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. |
policy |
Required. The policy to update. |
UpdateSpaceRequest
Message for updating a space.
| Fields | |
|---|---|
update_mask |
Optional. The fields to overwrite in the space update. If you don't provide a mask, all fields are overwritten. |
space |
Required. The space to update. |
UpdatedTemplateRevision
The updated template revision, which results in an outdated application.
| Fields | |
|---|---|
template_revision |
Output only. The details of the updated template revision. |
create_time |
Output only. The time when the template was created. |
template_display_name |
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 |
Output only. Value of the enum. |
label |
Output only. Label of the enum. |
ValueLabelInput
Value label input for a UI.
| Fields | |
|---|---|
value |
Optional. Value of the enum. |
label |
Optional. Label of the enum. |