Package types (0.1.0)

API documentation for designcenter_v1.types package.

Classes

AdcMetadata

Application Design Center specific information and metadata.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AlternateDefault

Alternate default for a UI input.

AlternateDefaultInput

Alternate default input for a UI.

ApiInfo

ApiInfo represents an API along with its origin.

AppHubApplicationParameters

App Hub application parameters.

Application

Represents the application resource.

ApplicationCompositionType

The composition type of the applicationTemplate or application: STANDARD OR COMPOSITE.

ApplicationOperation

Represents the type of operation to perform on an application.

ApplicationOperationMetadata

Ephemeral metadata depicting the state of the delete operation.

ApplicationOutputParameters

The application output parameters of the deployment.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ApplicationTemplate

Application template resource.

ApplicationTemplateOperation

Represents the type of operation to perform on an application template.

ApplicationTemplateRevision

Application template revision resource.

ApplicationTemplateSystemRevision

Application template system revision resource.

ApplicationType

The type of the application.

ApplyCondition

Condition for applying the policy. Accepts the criticality and environment parameters from the application template.

ArtifactLocation

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AssessedFramework

Framework assessed and their findings.

AssessmentFinding

Details of an Assessment Finding.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AssessmentReport

Aggregated assessment report from all domains.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AssetDetails

Details of a Cloud Asset Inventory asset that caused the finding.

Catalog

A catalog is a collection of templates.

CatalogTemplate

A template inside a catalog.

CatalogTemplateRevision

Template revisions inside a catalog.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CatalogTemplateRevisionMetadata

Represents metadata of a catalog template revision in the management context.

CloudControl

Cloud control for a framework.

CloudControlConfig

Parameter values stored for a single cloud control of a policy.

CodePosition

CodePosition represents a code location.

CodeRange

CodeRange represents a portion of code.

CommitApplicationTemplateRequest

Request message for CommitApplicationTemplate method.

Component

Component resource.

ComponentApplicationInfo

This captures the apphub application details associated with the component.

ComponentOutputParameters

The component output parameters of the deployment.

ComponentParameterSchema

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

ComponentParameters

Information about the component level parameters for an application.

ComponentVariable

The details of an input/output variable: the variable and the component Uri. name.

CompositeApplicationParameters

Holds parameters that are specific to composite applications.

ConfigureAndDeployTemplateRequest

Request message for ConfigureAndDeployTemplate.

ConfigureAndDeployTemplateResponse

Response message for ConfigureAndDeployTemplate. Populated inside Operation.response upon LRO completion.

Connection

Connection resource.

ConnectionConfig

Connection configuration for the application.

ConnectionDependencyType

Indicates the dependency type of the connection.

ConnectionParameters

Connection level parameters associated with each component within an application.

ConnectionSource

Defines the source of a connection.

ConnectionSpec

Defines the specifications of a connection.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateApplicationRequest

Message for creating an application.

CreateApplicationTemplateRequest

Message for creating an application template.

CreateCatalogRequest

Message for creating a catalog.

CreateCatalogTemplateRequest

Message for creating a catalog template.

CreateCatalogTemplateRevisionRequest

Message for creating a template revisions request.

CreateComponentRequest

Message for creating a component.

CreateConnectionRequest

Message for creating a connection.

CreatePolicyRequest

Message for creating a policy.

CreateShareRequest

Message for creating a share of a catalog.

CreateSpaceRequest

Message for creating a space.

DeleteApplicationRequest

Message for deleting an application.

DeleteApplicationTemplateRequest

Message for deleting an application template.

DeleteApplicationTemplateRevisionRequest

Message for deleting an application template revision.

DeleteCatalogRequest

Message for deleting a catalog.

DeleteCatalogTemplateRequest

Message for deleting a catalog template.

DeleteCatalogTemplateRevisionRequest

Message for deleting a template revision.

DeleteComponentRequest

Message for deleting a component.

DeleteConnectionRequest

Message for deleting a connection.

DeletePolicyRequest

Message for deleting a policy.

DeleteShareRequest

Message for deleting a share of a catalog.

DeleteSpaceRequest

Message for deleting a space.

DeployApplicationRequest

Message for deploying an application.

DeployApplicationResponse

Response for DeployApplication.

DeployedResource

DeployedResource represents a single deployed GCP resource.

DeployedResourceResponse

Common response message for the resource registration methods.

DeploymentAttemptMetadata

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

DeploymentError

The error associated with the deployment.

DeploymentFailureResolutionInfo

The call to action associated with the deployment issue.

DeploymentGroupMetadata

Metadata for the infra manager deployment group. A deployment group in Infrastructure Manager is a logical grouping of one or more deployments.

DeploymentMetadata

Deployment information for the application.

DeploymentOperationMetadata

Ephemeral metadata depicting the state of the deployment operation.

DeploymentSource

Source template information for the deployment.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeploymentTarget

The deployment target of the application.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeploymentUnitProgress

Single deployment unit progress info

DeveloperConnectConfig

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

DeveloperConnectExportConfig

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

DeveloperConnectSourceConfig

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

DisplayVariable

Additional display specific Template pertaining to a particular input variable.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

DisplayVariableToggle

Display variable toggle.

DisplayVariableVisibility

Visibility defines how the output is exposed.

Domain

Domain for assessment.

DomainAssessmentReport

The assessment report for each domain.

ExportApplicationIaCRequest

Request message for ExportApplicationIaC method.

ExportApplicationIaCResponse

Response message for ExportApplicationIaC method.

ExportApplicationTemplateIaCRequest

Request message for ExportApplicationTemplateIaC method.

ExportApplicationTemplateIaCResponse

Response message for ExportApplicationTemplateIaC method.

ExportApplicationTemplateRevisionIaCRequest

Request message for ExportApplicationTemplateRevisionIaC method.

ExportApplicationTemplateRevisionIaCResponse

Response message for ExportApplicationTemplateRevisionIaC method.

ExportIaCConfig

Configuration for exporting a resource as IAC.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FetchApplicationAssessmentReportRequest

Message for fetching an application assessment report.

FetchApplicationAssessmentReportResponse

Message for response of fetching an application assessment report.

FetchCatalogTemplateRevisionAssessmentReportRequest

Request message for FetchCatalogTemplateRevisionAssessmentReport.

FetchCatalogTemplateRevisionAssessmentReportResponse

Response message for FetchCatalogTemplateRevisionAssessmentReport.

FetchCatalogTemplateRevisionTFSourceRequest

Request message for fetching the Terraform source of a catalog template revision.

FetchCatalogTemplateRevisionTFSourceResponse

Response message for getting the Terraform source of a catalog template revision.

FetchFrameworksRequest

Request for FetchFrameworks rpc

FetchFrameworksResponse

Response for FetchFrameworks rpc

FetchSharedTemplateRevisionAssessmentReportRequest

Request message for FetchSharedTemplateRevisionAssessmentReport.

FetchSharedTemplateRevisionAssessmentReportResponse

Response message for FetchSharedTemplateRevisionAssessmentReport.

FetchSharedTemplateRevisionTFSourceRequest

Request message for fetching the Terraform source of a shared template revision.

FetchSharedTemplateRevisionTFSourceResponse

Response message for getting the Terraform source of a shared template revision.

Framework

Framework for assessment.

GKEDeploymentTarget

The GKE deployment target.

GenerateApplicationAssessmentReportRequest

Message for generating an application assessment report.

GenerateApplicationAssessmentReportResponse

Response for GenerateApplicationAssessmentReport.

GenerateApplicationIaCRequest

Request message for GenerateApplicationIaC method.

GenerateApplicationIaCResponse

Response message for GenerateApplicationIaC method.

GenerateApplicationTemplateAssessmentReportRequest

Message for generate assessment report application template.

GenerateApplicationTemplateAssessmentReportResponse

Response for GenerateAssessmentReport for application template.

GenerateApplicationTemplateIaCRequest

Request message for GenerateApplicationTemplateIaC method.

GenerateApplicationTemplateIaCResponse

Response message for GenerateApplicationTemplateIaC method.

GenerateApplicationTemplateRevisionIaCRequest

Request message for GenerateApplicationTemplateRevisionIaC method.

GenerateApplicationTemplateRevisionIaCResponse

Response message for GenerateApplicationTemplateRevisionIaC method.

GenerateAssessmentReportOperationMetadata

Ephemeral metadata depicting the state of assessment report generation.

GenerateAssessmentReportRequest

Deprecated: Use GenerateTerraformPlanAssessmentReportRequest instead. Message for the request to generate a best practice report for a given Terraform plan.

GenerateAssessmentReportResponse

Deprecated: Use GenerateTerraformPlanAssessmentReportResponse instead. Response for GenerateAssessmentReport.

GenerateTerraformPlanAssessmentReportRequest

Message for the request to generate a best practice report for a given Terraform plan at the collection level.

GenerateTerraformPlanAssessmentReportResponse

Response for GenerateTerraformPlanAssessmentReport.

GetApplicationRequest

Message for getting an application.

GetApplicationTemplateRequest

Message for getting an application template.

GetApplicationTemplateRevisionRequest

Message for getting an application template revision.

GetApplicationTemplateSystemRevisionRequest

Message for getting an ApplicationTemplateSystemRevision.

GetCatalogRequest

Message for getting a catalog.

GetCatalogTemplateRequest

Message for getting a catalog template resource.

GetCatalogTemplateRevisionRequest

Message for GetTemplateRevision Request

GetComponentRequest

Message for getting a component.

GetConnectionRequest

Message for getting a connection.

GetPolicyRequest

Message for getting a policy.

GetShareRequest

Message for getting a share of a catalog.

GetSharedTemplateRequest

Message for getting a shared template.

GetSharedTemplateRevisionRequest

Message for getting a shared template revisions.

GetSpaceRequest

Results returned from projects.locations.spaces.get.

GitReference

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GitSource

Defines how to access a Git source.

HelmApplicationOutputParameters

The helm application output parameters of the deployment.

HelmChartInput

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

HelmChartMetadata

Helm Chart metadata.

HelmChartOutput

Helm Chart outputs.

IACFormat

The IaC format to generate.

IACSource

Enum to specify the source format of the IaC.

IaCFile

IaCFile represents a single infrastructure as code file.

IaCModule

IaCModule represents a single infrastructure as code module.

IacFormatInfo

IacFormatInfo defines the actuation tool used to provision the Template.

ImportApplicationIaCRequest

Request message for ImportApplicationIaC method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportApplicationIaCResponse

Response message for ImportApplicationIaC method.

ImportApplicationTemplateIaCRequest

Request message for ImportApplicationTemplateIaC method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportApplicationTemplateIaCResponse

Response message for ImportApplicationTemplateIaC method.

ImportApplicationTemplateRequest

Request message for ImportApplicationTemplate method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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 }

ImportSerializedApplicationTemplateRequest

Request message for ImportSerializedApplicationTemplate.

InferredMetadata

Inferred metadata.

IngestApplicationTemplateIaCRequest

Request message for IngestApplicationTemplateIaC method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IngestApplicationTemplateIaCResponse

Response message for IngestApplicationTemplateIaC method.

InputVariableAlias

Input variable alias mapping for a component in a composite application template.

ListApplicationTemplateRevisionsRequest

Message for requesting a list of application template revisions.

ListApplicationTemplateRevisionsResponse

Message for response to listing application template revisions.

ListApplicationTemplateSystemRevisionsRequest

Message for requesting a list of application template system revisions.

ListApplicationTemplateSystemRevisionsResponse

Message for response to listing application template system revisions.

ListApplicationTemplatesRequest

Message for requesting a list of application templates.

ListApplicationTemplatesResponse

Message for response to listing application templates.

ListApplicationsRequest

Message for requesting a list of applications.

ListApplicationsResponse

Message for response to listing applications.

ListCatalogTemplateRevisionMetadataResponse

Response message for ListCatalogTemplateRevisionMetadata.

ListCatalogTemplateRevisionsRequest

Message for requesting list of template revisions.

ListCatalogTemplateRevisionsResponse

Message for response to listing template revisions.

ListCatalogTemplatesRequest

Message for requesting a list of catalog templates.

ListCatalogTemplatesResponse

Message for response to listing catalog templates.

ListCatalogsRequest

Message for requesting a list of catalogs.

ListCatalogsResponse

Results returned from catalogs.list.

ListComponentsRequest

Message for requesting a list of components.

ListComponentsResponse

Message for response to listing components.

ListConnectionsRequest

Message for requesting a list of connections.

ListConnectionsResponse

Message for response to listing connections.

ListPoliciesRequest

Message for requesting a list of policies.

ListPoliciesResponse

Message for response to listing policies.

ListSharedTemplateRevisionsRequest

Message for requesting a list of shared template revisions.

ListSharedTemplateRevisionsResponse

Message for response to listing shared templates.

ListSharedTemplatesRequest

Message for requesting list of shared templates.

ListSharedTemplatesResponse

Message for response to listing shared templates.

ListSharesRequest

Message for listing shares of a catalog.

ListSharesResponse

Message for response to listing shares of a catalog.

ListSpacesRequest

Message for requesting a list of spaces.

ListSpacesResponse

Results returned from projects.locations.spaces.list.

LogicalProduct

Represents a Product Main logical product.

MetadataInput

Metadata for the input

MetadataInputSpec

Specifications for the input

ModuleDependency

Represents a dependency on another Terraform module.

ModuleDetails

Details about a specific module, submodule, or example.

ModuleInput

Represents an input variable for a module.

ModuleOutput

Represents an output value from a module.

ModuleResource

Represents a resource declared within a module.

OciRepo

Open Container Initiative (OCI) repo.

OperationMetadata

Represents the metadata of the long-running operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Parameter

Parameter resource.

ParameterSpec

The specification of a parameter that can be configured on a cloud control or a framework.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PreviewApplicationRequest

Message for previewing an application.

PreviewApplicationResponse

Response for PreviewApplication.

PreviewOperationMetadata

Ephemeral metadata depicting the state of the preview operation.

ProjectParameters

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

ProjectParametersList

Provides the list of project parameters needed to deploy an application.

ProviderDependency

Represents a dependency on a Terraform provider.

ProviderVersion

ProviderVersion defines the required version for a provider.

ProvisionDeploymentGroupOperationMetadata

Represents the Provision Deployment Group operation metadata.

RecommendIAMRolesRequest

Request message for RecommendIAMRoles.

RecommendIAMRolesResponse

Response message for RecommendIAMRoles.

RegisterAppHubApplicationResourcesRequest

Request message for RegisterAppHubApplicationResources method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RegisterAppHubApplicationResourcesResponse

Response message for RegisterAppHubApplicationResources method.

RemediationStep

Remediation steps that can be taken to rectify the finding.

Resource

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

ResourceType

Represents the type of a resource within a component template.

RoleInfo

RoleInfo represents an IAM role along with its origin.

RolesAndApisConfig

Represents configurations required within a specific project to deploy the application.

RootInputVariable

Input variable of a root module.

RootModule

Metadata for a root module.

RootModuleDependency

Root module dependency.

RootModulesMetadata

Root modules metadata.

RootOutputVariable

Output variable of a root module.

SCCMetadata

SCC metadata for the assessment finding.

SaaSRuntimeContext

SaaS runtime context.

ScoreCard

Score card associated with the report.

SerializedApplicationTemplate

Serialized application template.

SerializedComponent

Serialized component.

SerializedConnection

Serialized connection.

SerializedPolicy

Serialized policy.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SerializedProvider

Represents a serialized Terraform provider configuration.

A catalog share between spaces.

SharedTemplate

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

SharedTemplateRevision

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SkippedDomain

Domains skipped during the best practice assessment.

SnapshotApplicationTemplateRequest

Message for snapshotting an application template asynchronously.

SnapshotApplicationTemplateResponse

Response message for snapshotting an application template asynchronously.

Space

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SyncShareRequest

Message for syncing a share of a catalog.

TFBlueprintMetadata

Terraform input and output metadata.

TemplateCategory

Supported categories in Application Design Center.

TemplateConnections

TemplateInfo

TemplateInfo provides the actuation tool information.

TemplateRequirements

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

TemplateRoles

Template Roles provide the level and roles

TemplateSchema

TemplateSchema provides the input variables lists and connection information.

TemplateType

Assembly template types.

TemplateUi

TemplateUi defines the UI related information for the Template.

TemplateUiInput

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

TemplateUiOutput

TemplateUiOutput defines the list of outputs and their visibility on the deployment page.

TemplateUiOutputDisplayVariable

Additional display specific Template pertaining to a particular output variable.

TemplateVariable

TemplateTerraform inputs.

TerraformBlueprintUiMetadata

Terraform blueprint UI metadata.

TerraformConfig

Configuration for exporting a resource as Terraform IAC.

TerraformFile

Represents a single Terraform file.

TerraformInput

Terraform inputs.

TerraformInputConnections

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" } ] }