package google.cloud.config.bpmetadata
Get desktop application:
View/edit binary Protocol Buffers messages
message
bpmetadata.proto:240BlueprintActuationTool defines the actuation tool used to provision the blueprint.
Used in:
string flavor = 1
Gen: auto-generated - set as "Terraform" for now until more flavors are supported.
@gotags: json:"flavor,omitempty" yaml:"flavor,omitempty"
string version = 2
Required version for the actuation tool. Gen: auto-generated - For Terraform this is the `required_version` set in `terraform` block. E.g. terraform { required_version = ">= 0.13" }
@gotags: json:"version,omitempty" yaml:"version,omitempty"
message
bpmetadata.proto:436Used in:
string diagram_url = 1
Gen: auto-generated - the URL & list content following the "## Architecture" tag e.g. ## Architecture  1. Step no. 1 2. Step no. 2 3. Step no. 3
@gotags: json:"diagramUrl" yaml:"diagramUrl"
repeated string description = 2
Gen: auto-generated - the list items following the "## Architecture" tag.
@gotags: json:"description" yaml:"description"
message
bpmetadata.proto:363BlueprintAuthor defines the author of a blueprint.
Used in:
string title = 1
Name of template author or organization. Gen: manually-authored
@gotags: json:"title" yaml:"title"
string description = 2
Description of the author. Gen: manually-authored
@gotags: json:"description,omitempty" yaml:"description,omitempty"
string url = 3
Link to the author's website. Gen: manually-authored
@gotags: json:"url,omitempty" yaml:"url,omitempty"
message
bpmetadata.proto:298GCP cloud product(s) used in the blueprint.
Used in:
string product_id = 1
A top-level (e.g. "Compute Engine") or secondary (e.g. "Binary Authorization") product used in the blueprint. Gen: manually-authored
@gotags: json:"productId,omitempty" yaml:"productId,omitempty"
string page_url = 2
Url for the product. Gen: manually-authored
@gotags: json:"pageUrl" yaml:"pageUrl"
string label = 3
A label string for the product, if it is not an integrated GCP product. E.g. "Data Studio" Gen: manually-authored
@gotags: json:"label,omitempty" yaml:"label,omitempty"
bool is_external = 4
Is the product's landing page external to the GCP console e.g. lookerstudio.google.com Gen: manually-authored
@gotags: json:"isExternal,omitempty" yaml:"isExternal,omitempty"
message
bpmetadata.proto:479Defines an incoming connection from a blueprint.
Used in:
optional source = 1
Source of the connection. Gen: manually-authored.
@gotags: json:"source,omitempty" yaml:"source,omitempty"
optional spec = 2
Connection specifications. Gen: manually-authored.
@gotags: json:"spec,omitempty" yaml:"spec,omitempty"
message
bpmetadata.proto:149BlueprintContent defines the detail for blueprint related content such as related documentation, diagrams, examples etc.
Used in:
optional architecture = 1
Gen: auto-generated
@gotags: json:"architecture,omitempty" yaml:"architecture,omitempty"
repeated diagrams = 2
Gen: manually-authored
@gotags: json:"diagrams,omitempty" yaml:"diagrams,omitempty"
repeated documentation = 3
Gen: auto-generated - the list content following the "## Documentation" tag. E.g. ## Documentation - [Hosting a Static Website](https://cloud.google.com/storage/docs/hosting-static-website)
@gotags: json:"documentation,omitempty" yaml:"documentation,omitempty"
repeated sub_blueprints = 4
Gen: auto-generated - blueprints under the modules/ folder.
@gotags: json:"subBlueprints,omitempty" yaml:"subBlueprints,omitempty"
repeated examples = 5
Gen: auto-generated - examples under the examples/ folder.
@gotags: json:"examples,omitempty" yaml:"examples,omitempty"
message
bpmetadata.proto:288The cost estimate for the blueprint based on pre-configured variables.
Used in:
string description = 1
Gen: auto-generated - Set using the content defined under "### Cost" as a link with a description E.g. ### Cost [$20.00](https://cloud.google.com/products/calculator?hl=en_US&_ga=2.1665458.-226505189.1675191136#id=02fb0c45-cc29-4567-8cc6-f72ac9024add)
@gotags: json:"description" yaml:"description"
string url = 2
@gotags: json:"url" yaml:"url"
message
bpmetadata.proto:256All descriptions are set with the markdown content immediately after each type's heading declaration in readme.md.
Used in:
string tagline = 1
Gen: auto-generated - Markdown after "### Tagline".
@gotags: json:"tagline,omitempty" yaml:"tagline,omitempty"
string detailed = 2
Gen: auto-generated - Markdown after "### Detailed".
@gotags: json:"detailed,omitempty" yaml:"detailed,omitempty"
string pre_deploy = 3
Gen: auto-generated - Markdown after "### PreDeploy".
@gotags: json:"preDeploy,omitempty" yaml:"preDeploy,omitempty"
string html = 4
Gen: auto-generated - Markdown after "### Html".
@gotags: json:"html,omitempty" yaml:"html,omitempty"
repeated string eula_urls = 5
Gen: auto-generated - Markdown after "### EulaUrls".
@gotags: json:"eulaUrls,omitempty" yaml:"eulaUrls,omitempty"
repeated string architecture = 6
Gen: auto-generated - Markdown after "### Architecture" Deprecated. Use BlueprintContent.Architecture instead.
@gotags: json:"architecture,omitempty" yaml:"architecture,omitempty"
message
bpmetadata.proto:454Used in:
string name = 1
@gotags: json:"name" yaml:"name"
string alt_text = 2
@gotags: json:"altText,omitempty" yaml:"altText,omitempty"
string description = 3
@gotags: json:"description,omitempty" yaml:"description,omitempty"
message
bpmetadata.proto:77BlueprintInfo defines the basic information of the blueprint.
Used in:
string title = 1
Title for the blueprint. Gen: auto-generated - First H1 text in readme.md.
@gotags: json:"title" yaml:"title"
optional source = 2
Blueprint source location and source type. Gen: auto-generated - user will be prompted if repo information can not be determined from the blueprint path.
@gotags: json:"source,omitempty" yaml:"source,omitempty"
string version = 3
Last released semantic version for the packaged blueprint. Gen: auto-generated - From the `module_name` attribute of the `provider_meta "google"` block. E.g. provider_meta "google" { module_name = "blueprints/terraform/terraform-google-log-analysis/v0.1.5" }
@gotags: json:"version,omitempty" yaml:"version,omitempty"
optional actuation_tool = 4
Actuation tool e.g. Terraform and its required version. Gen: auto-generated
@gotags: json:"actuationTool,omitempty" yaml:"actuationTool,omitempty"
optional description = 5
Various types of descriptions associated with the blueprint. Gen: auto-generated
@gotags: json:"description,omitempty" yaml:"description,omitempty"
string icon = 6
Path to an image representing the icon for the blueprint. Will be set as "assets/icon.png", if present. Gen: auto-generated
@gotags: json:"icon,omitempty" yaml:"icon,omitempty"
optional deployment_duration = 7
The time estimate for configuring and deploying the blueprint. Gen: auto-generated
@gotags: json:"deploymentDuration,omitempty" yaml:"deploymentDuration,omitempty"
optional cost_estimate = 8
The cost estimate for the blueprint based on preconfigured variables. Gen: auto-generated
@gotags: json:"costEstimate,omitempty" yaml:"costEstimate,omitempty"
repeated cloud_products = 9
A list of GCP cloud products used in the blueprint. Gen: manually-authored
@gotags: json:"cloudProducts,omitempty" yaml:"cloudProducts,omitempty"
repeated quota_details = 10
A configuration of fixed and dynamic GCP quotas that apply to the blueprint. Gen: manually-authored
@gotags: json:"quotaDetails,omitempty" yaml:"quotaDetails,omitempty"
optional author = 11
Details on the author producing the blueprint. Gen: manually-authored
@gotags: json:"author,omitempty" yaml:"author,omitempty"
repeated software_groups = 12
Details on software installed as part of the blueprint. Gen: manually-authored
@gotags: json:"softwareGroups,omitempty" yaml:"softwareGroups,omitempty"
optional support_info = 13
Support offered, if any for the blueprint. Gen: manually-authored
@gotags: json:"supportInfo,omitempty" yaml:"supportInfo,omitempty"
repeated org_policy_checks = 14
A list of GCP org policies to be checked for successful deployment. Gen: manually-authored
@gotags: json:"orgPolicyChecks,omitempty" yaml:"orgPolicyChecks,omitempty"
bool single_deployment = 15
Specifies if the blueprint supports single or multiple deployments per GCP project. If set to true, the blueprint can not be deployed more than once in the same GCP project. Gen: manually-authored
@gotags: json:"singleDeployment,omitempty" yaml:"singleDeployment,omitempty"
message
bpmetadata.proto:169BlueprintInterface defines the input and output variables for the blueprint.
Used in:
repeated variables = 1
Gen: auto-generated - all defined variables for the blueprint
@gotags: json:"variables,omitempty" yaml:"variables,omitempty"
repeated variable_groups = 2
Gen: manually-authored
@gotags: json:"variableGroups,omitempty" yaml:"variableGroups,omitempty"
repeated outputs = 3
Gen: auto-generated - all defined outputs for the blueprint
@gotags: json:"outputs,omitempty" yaml:"outputs,omitempty"
message
bpmetadata.proto:460Used in:
string title = 1
@gotags: json:"title" yaml:"title"
string url = 2
@gotags: json:"url,omitempty" yaml:"url,omitempty"
message
bpmetadata.proto:19BlueprintMetadata defines the overall structure for blueprint metadata. The cli command i.e. `cft blueprint metadata` attempts at auto-generating metadata if the blueprint is structured based on the TF blueprint template i.e. https://github.com/terraform-google-modules/terraform-google-module-template All fields within BlueprintMetadata and its children are denoted as: - Gen: auto-generated - <data source> - Gen: manually-authored - Gen: partial (contains nested messages that can include both auto-generated and manually authored)
string api_version = 1
APIVersion is the apiVersion field of a metadata file Gen: auto-generated
@gotags: json:"apiVersion,omitempty" yaml:"apiVersion,omitempty"
string kind = 2
Kind is the kind field of a metadata file Gen: auto-generated
@gotags: json:"kind,omitempty" yaml:"kind,omitempty"
optional metadata = 3
ResourceTypeMeta is the metadata field of a metadata file Gen: partial
@gotags: json:"metadata,omitempty" yaml:"metadata,omitempty"
optional spec = 4
BlueprintMetadataSpec is the metadata specification for the blueprint Gen: partial
@gotags: yaml:"spec" json:"spec"
message
bpmetadata.proto:52BlueprintMetadataSpec defines the spec portion of the blueprint metadata.
Used in:
optional info = 1
BlueprintInfo defines the basic information of the blueprint. Gen: partial
@gotags: json:"info,omitempty" yaml:"info,omitempty"
optional content = 2
BlueprintContent defines the detail for blueprint related content such as related documentation, diagrams, examples etc. Gen: partial
@gotags: json:"content,omitempty" yaml:"content,omitempty"
optional interfaces = 3
BlueprintInterface defines the input and output variables for the blueprint. Gen: partial
@gotags: json:"interfaces,omitempty" yaml:"interfaces,omitempty"
optional requirements = 4
BlueprintRequirements defines the roles required and the associated services that need to be enabled to provision blueprint resources. Gen: auto-generated
@gotags: json:"requirements,omitempty" yaml:"requirements,omitempty"
optional ui = 5
BlueprintUI defines the user interface for the blueprint. Gen: partial
@gotags: json:"ui,omitempty" yaml:"ui,omitempty"
message
bpmetadata.proto:449Used in:
string name = 1
@gotags: json:"name" yaml:"name"
string location = 2
@gotags: json:"location,omitempty" yaml:"location,omitempty"
message
bpmetadata.proto:321BlueprintOrgPolicyCheck defines GCP org policies to be checked for successful deployment
Used in:
string policy_id = 1
Id for the policy e.g. "compute-vmExternalIpAccess" Gen: manually-authored
@gotags: json:"policyId" yaml:"policyId"
repeated string required_values = 2
If not set, it is assumed any version of this org policy prevents successful deployment of this solution. Gen: manually-authored
@gotags: json:"requiredValues,omitempty" yaml:"requiredValues,omitempty"
message
bpmetadata.proto:519Used in:
string name = 1
@gotags: json:"name" yaml:"name"
string description = 2
@gotags: json:"description,omitempty" yaml:"description,omitempty"
optional type = 3
Serialized type representation of the output value. Gen: manually-authored but will be automated in the future.
@gotags: json:"type,omitempty" yaml:"type,omitempty"
message
bpmetadata.proto:340BlueprintQuotaDetail defines the quota details for a blueprint.
Used in:
string dynamic_variable = 1
DynamicVariable, if provided, associates the provided input variable with the corresponding resource and quota type. In its absence, the quota detail is assumed to be fixed. Gen: manually-authored
@gotags: json:"dynamicVariable,omitempty" yaml:"dynamicVariable,omitempty"
QuotaResourceType resource_type = 2
ResourceType is the type of resource the quota will be applied to i.e. GCE Instance or Disk etc. Gen: manually-authored
@gotags: json:"resourceType" yaml:"resourceType"
map<string, string> quota_type = 3
QuotaType is a key/value pair of the actual quotas and their corresponding values. Valid keys for quota_type can be: MACHINE_TYPE, CPUs, DISK_TYPE OR SIZE_GB. Gen: manually-authored
@gotags: json:"quotaType" yaml:"quotaType"
message
bpmetadata.proto:225Used in:
string repo = 1
Gen: auto-generated - URL from the .git dir. Can be manually overridden with a custom URL if needed.
@gotags: json:"repo" yaml:"repo"
string source_type = 2
Gen: auto-generated - set as "git" for now until more types are supported.
@gotags: json:"sourceType" yaml:"sourceType"
string dir = 3
Gen: auto-generated - not set for root modules but set as the module name for submodules, if found.
@gotags: json:"dir,omitempty" yaml:"dir,omitempty"
message
bpmetadata.proto:182BlueprintRequirements defines the roles required and the associated services that need to be enabled to provision blueprint resources.
Used in:
repeated roles = 1
Gen: auto-generated - all roles required for the blueprint in test/setup/iam.tf as the "int_required_roles" local. E.g. locals { int_required_roles = [ "roles/compute.admin", ] }
@gotags: json:"roles,omitempty" yaml:"roles,omitempty"
repeated string services = 2
Gen: auto-generated - all services required for the blueprint in test/setup/main.tf as "activate_apis" in the project module.
@gotags: json:"services,omitempty" yaml:"services,omitempty"
repeated provider_versions = 3
Required provider versions. Gen: auto-generated from required providers block.
@gotags: json:"providerVersions,omitempty" yaml:"providerVersions,omitempty"
message
bpmetadata.proto:528Used in:
string level = 1
@gotags: json:"level" yaml:"level"
repeated string roles = 2
@gotags: json:"roles" yaml:"roles"
message
bpmetadata.proto:398A description of a piece of a single software component installed by the blueprint.
Used in:
string title = 1
User-visible title. Gen: manually-authored
@gotags: json:"title" yaml:"title"
string version = 2
Software version. Gen: manually-authored
@gotags: json:"version,omitempty" yaml:"version,omitempty"
string url = 3
Link to development site or marketing page for this software. Gen: manually-authored
@gotags: json:"url,omitempty" yaml:"url,omitempty"
string license_url = 4
Link to license page. Gen: manually-authored
@gotags: json:"licenseUrl,omitempty" yaml:"licenseUrl,omitempty"
message
bpmetadata.proto:386A group of related software components for the blueprint.
Used in:
SoftwareGroupType type = 1
Pre-defined software types. Gen: manually-authored
@gotags: json:"type,omitempty" yaml:"type,omitempty"
repeated software = 2
Software components belonging to this group. Gen: manually-authored
@gotags: json:"software,omitempty" yaml:"software,omitempty"
message
bpmetadata.proto:417A description of a support option
Used in:
string description = 1
Description of the support option. Gen: manually-authored
@gotags: json:"description" yaml:"description"
string url = 2
Link to the page providing this support option. Gen: manually-authored
@gotags: json:"url,omitempty" yaml:"url,omitempty"
string entity = 3
The organization or group that provides the support option (e.g.: "Community", "Google"). Gen: manually-authored
@gotags: json:"entity,omitempty" yaml:"entity,omitempty"
bool show_support_id = 4
Whether to show the customer's support ID. Gen: manually-authored
@gotags: json:"showSupportId,omitempty" yaml:"showSupportId,omitempty"
message
bpmetadata.proto:278A time estimate in secs required for configuring and deploying the blueprint.
Used in:
int64 configuration_secs = 1
Gen: auto-generated - Set using the content defined under "### DeploymentTime" E.g. ### DeploymentTime - Configuration: X secs - Deployment: Y secs
@gotags: json:"configurationSecs,omitempty" yaml:"configurationSecs,omitempty"
int64 deployment_secs = 2
@gotags: json:"deploymentSecs,omitempty" yaml:"deploymentSecs,omitempty"
message
bpmetadata.proto:213BlueprintUI is the top-level structure for holding UI specific metadata.
Used in:
optional input = 1
The top-level input section that defines the list of variables and their sections on the deployment page. Gen: partial
@gotags: json:"input,omitempty" yaml:"input,omitempty"
optional runtime = 2
The top-level section for listing runtime (or blueprint output) information i.e. the console URL for the VM or a button to ssh into the VM etc based on. Gen: manually-authored
@gotags: json:"runtime,omitempty" yaml:"runtime,omitempty"
message
bpmetadata_ui.proto:12BlueprintUIInput is the structure for holding Input and Input Section (i.e. groups) specific metadata.
Used in:
map<string, > variables = 1
variables is a map defining all inputs on the UI. Gen: partial
@gotags: json:"variables,omitempty" yaml:"variables,omitempty"
repeated sections = 2
Sections is a generic structure for grouping inputs together. Gen: manually-authored
@gotags: json:"sections,omitempty" yaml:"sections,omitempty"
repeated boolean_groups = 3
List of boolean groups that will be referenced by properties. Gen: manually-authored
@gotags: json:"booleanGroups,omitempty" yaml:"booleanGroups,omitempty"
message
bpmetadata_ui.proto:237Used in:
string output_message = 1
Short message to be displayed while the blueprint is deploying. At most 128 characters. Gen: manually-authored
@gotags: json:"outputMessage,omitempty" yaml:"outputMessage,omitempty"
repeated suggested_actions = 2
List of suggested actions to take. Gen: manually-authored
@gotags: json:"suggestedActions,omitempty" yaml:"suggestedActions,omitempty"
map<string, > outputs = 3
outputs is a map defining a subset of Terraform outputs on the UI that may need additional UI configuration. Gen: manually-authored
@gotags: json:"outputs,omitempty" yaml:"outputs,omitempty"
message
bpmetadata.proto:465Used in:
string name = 1
@gotags: json:"name,omitempty" yaml:"name,omitempty"
string description = 2
@gotags: json:"description,omitempty" yaml:"description,omitempty"
string var_type = 3
@gotags: json:"varType,omitempty" yaml:"varType,omitempty"
optional default_value = 4
@gotags: json:"defaultValue,omitempty" yaml:"defaultValue,omitempty"
bool required = 5
@gotags: json:"required,omitempty" yaml:"required,omitempty"
repeated connections = 6
Incoming connections to this variable. Connections are outputs from other blueprints that can be potentially connected to this variable. Gen: manually-authored.
@gotags: json:"connections,omitempty" yaml:"connections,omitempty"
message
bpmetadata.proto:513BlueprintVariableGroup is manually entered.
Used in:
string name = 1
@gotags: json:"name" yaml:"name"
string description = 2
@gotags: json:"description,omitempty" yaml:"description,omitempty"
repeated string variables = 3
@gotags: json:"variables,omitempty" yaml:"variables,omitempty"
message
bpmetadata_ui.proto:212Groups a list of boolean properties into one logical property for the purposes of the configuration form. The title of a [BooleanGroup][] has the same styling as the title of an ordinary property, and individual properties in the group will be packed more tightly together to indicate their association. Child of [Input][].
Used in:
string name = 1
The name of the group, referenced by [Property][] <code>.booleanGroup</code>. BooleanGroup names must be unique. Required. Gen: manually-authored
@gotags: json:"name" yaml:"name"
string title = 2
Group title. Required. UTF-8 text. No markup. At most 64 characters. Gen: manually-authored
@gotags: json:"title" yaml:"title"
string tooltip = 3
Group tooltip. Optional. HTML (<code><a href></code> tags only). At most 256 characters. Gen: manually-authored
@gotags: json:"tooltip,omitempty" yaml:"tooltip,omitempty"
string subtext = 4
Group subtext. Optional. HTML (<code><a href></code> tags only). At most 256 characters. Gen: manually-authored
@gotags: json:"subtext,omitempty" yaml:"subtext,omitempty"
message
bpmetadata.proto:489Defines the source of a connection.
Used in:
string source = 1
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. Gen: manually-authored.
@gotags: json:"source,omitempty" yaml:"source,omitempty"
string version = 2
Version constraint syntax using the same format as module version constraints. Gen: manually-authored.
@gotags: json:"version,omitempty" yaml:"version,omitempty"
message
bpmetadata.proto:502Defines the specifications of a connection.
Used in:
string output_expr = 1
Output expression identifying output being connected to variable. This can be the output name or more complex expression like attribuite notation. Gen: manually-authored.
@gotags: json:"outputExpr,omitempty" yaml:"outputExpr,omitempty"
optional string input_path = 2
Optional dot separated attribuite notation to connect to a specific object field of the input variable. Gen: manually-authored.
@gotags: json:"inputPath,omitempty" yaml:"inputPath,omitempty"
message
bpmetadata_ui.proto:282Additional display specific metadata pertaining to a particular Terraform output. Only applicable for Outputs that are URLs.
Used in:
bool open_in_new_tab = 1
open_in_new_tab defines if the Output action should be opened in a new tab. Gen: manually-authored
@gotags: json:"openInNewTab,omitempty" yaml:"openInNewTab,omitempty"
bool show_in_notification = 2
show_in_notification defines if the Output should shown in notification for the deployment. Gen: manually-authored
@gotags: json:"showInNotification,omitempty" yaml:"showInNotification,omitempty"
string label = 3
label to display on the Output action button Gen: manually-authored
@gotags: json:"label,omitempty" yaml:"label,omitEmpty"
DisplayOutput.Visibility visibility = 4
@gotags: json:"visibility,omitempty" yaml:"visibility,omitEmpty"
Visibility defines how the output is exposed. Gen: manually-authored.
Used in:
VISIBILITY_UNSPECIFIED = 0
Default
VISIBILITY_ROOT = 1
Expose output as root module output.
message
bpmetadata_ui.proto:183A logical group of variables. [Section][]s may also be grouped into sub-sections.
Used in:
string name = 1
The name of the section, referenced by DisplayVariable.Section Section names must be unique. Gen: manually-authored
@gotags: json:"name" yaml:"name"
string title = 2
Section title. If not provided, name will be used instead. Gen: manually-authored
@gotags: json:"title,omitempty" yaml:"title,omitempty"
string tooltip = 3
Section tooltip. Gen: manually-authored
@gotags: json:"tooltip,omitempty" yaml:"tooltip,omitempty"
string subtext = 4
Section subtext. Gen: manually-authored
@gotags: json:"subtext,omitempty" yaml:"subtext,omitempty"
string parent = 5
The name of the parent section (if parent is not the root section). Gen: manually-authored
@gotags: json:"parent,omitempty" yaml:"parent,omitempty"
message
bpmetadata_ui.proto:28Additional display specific metadata pertaining to a particular input variable.
Used in:
string name = 1
The variable name from the corresponding standard metadata file. Gen: auto-generated - the Terraform variable name
@gotags: json:"name" yaml:"name"
string title = 2
Visible title for the variable on the UI. If not present, Name will be used for the Title. Gen: auto-generated - the Terraform variable converted to title case e.g. variable "bucket_admins" will convert to "Bucket Admins" as the title.
@gotags: json:"title" yaml:"title"
bool invisible = 3
A flag to hide or show the variable on the UI. Gen: manually-authored
@gotags: json:"invisible,omitempty" yaml:"invisible,omitempty"
string tooltip = 4
Variable tooltip. Gen: manually-authored
@gotags: json:"tooltip,omitempty" yaml:"tooltip,omitempty"
string placeholder = 5
Placeholder text (when there is no default). Gen: manually-authored
@gotags: json:"placeholder,omitempty" yaml:"placeholder,omitempty"
string regex_validation = 6
Regex based validation rules for the variable. Gen: manually-authored
@gotags: json:"regexValidation,omitempty" yaml:"regexValidation,omitempty"
int32 min_items = 7
Minimum no. of inputs for the input variable. Gen: manually-authored
@gotags: json:"minItems,omitempty" yaml:"minItems,omitempty"
int32 max_items = 8
Max no. of inputs for the input variable. Gen: manually-authored
@gotags: json:"maxItems,omitempty" yaml:"maxItems,omitempty"
int32 min_length = 9
Minimum length for string values. Gen: manually-authored
@gotags: json:"minLength,omitempty" yaml:"minLength,omitempty"
int32 max_length = 10
Max length for string values. Gen: manually-authored
@gotags: json:"maxLength,omitempty" yaml:"maxLength,omitempty"
float min = 11
Minimum value for numeric types. Gen: manually-authored
@gotags: json:"min,omitempty" yaml:"min,omitempty"
float max = 12
Max value for numeric types. Gen: manually-authored
@gotags: json:"max,omitempty" yaml:"max,omitempty"
string section = 13
The name of a section to which this variable belongs. variables belong to the root section if this field is not set. Gen: manually-authored
@gotags: json:"section,omitempty" yaml:"section,omitempty"
optional x_google_property = 14
UI extension associated with the input variable. E.g. for rendering a GCE machine type selector: xGoogleProperty: type: GCE_MACHINE_TYPE zoneProperty: myZone gceMachineType: minCpu: 2 minRamGb: Gen: manually-authored
@gotags: json:"xGoogleProperty,omitempty" yaml:"xGoogleProperty,omitempty"
string validation = 15
Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters. Gen: manually-authored
@gotags: json:"validation,omitempty" yaml:"validation,omitempty"
string subtext = 16
Property subtext, displayed below the title. Gen: manually-authored
@gotags: json:"subtext,omitempty" yaml:"subtext,omitempty"
repeated enum_value_labels = 17
Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters. Gen: manually-authored
@gotags: json:"enumValueLabels,omitempty" yaml:"enumValueLabels,omitempty"
int32 level = 18
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. Gen: manually-authored
@gotags: json:"level,omitempty" yaml:"level,omitempty"
string boolean_group = 20
The name of a boolean group from Input.booleanGroups to which this property belongs. Only allowed for properties declared as type boolean in the schema. Properties in a boolean group must be adjacent in the properties list and must belong to the same section (if any). Optional. Gen: manually-authored
@gotags: json:"booleanGroup,omitempty" yaml:"booleanGroup,omitempty"
repeated alt_defaults = 21
@gotags: json:"altDefaults,omitempty" yaml:"altDefaults,omitempty"
repeated toggle_using_variables = 22
@gotags: json:"toggleUsingVariables,omitempty" yaml:"toggleUsingVariables,omitempty"
message
bpmetadata_ui.proto:135Alternate default value. This allows authors to define an alternative value for pre identified usecases such as security. If specified, this value can be used instead of the default value in BlueprintVariable. Gen: manually-authored.
Used in:
AlternateDefault.AlternateType type = 1
@gotags: json:"type,omitempty" yaml:"type,omitempty"
optional value = 2
Value of the alternate default.
@gotags: json:"value,omitempty" yaml:"value,omitempty"
Type of the alternate default.
Used in:
ALTERNATE_TYPE_UNSPECIFIED = 0
Default
ALTERNATE_TYPE_SECURITY = 1
A more secure default.
ALTERNATE_TYPE_DC = 2
A default specifically needed for Design center.
message
bpmetadata_ui.proto:154Used in:
string variable_name = 1
The name of the variable used to toggle the display of another variable.
@gotags: json:"variableName,omitempty" yaml:"variableName,omitempty"
repeated string variable_values = 2
The value of the variable used to toggle the display of another variable.
@gotags: json:"variableValues,omitempty" yaml:"variableValue,omitempty"
DisplayVariableToggle.ToggleType type = 3
The type of the variable used to toggle the display of another variable.
@gotags: json:"type,omitempty" yaml:"type,omitempty"
Used in:
DISPLAY_VARIABLE_TOGGLE_TYPE_UNSPECIFIED = 0
Default
DISPLAY_VARIABLE_TOGGLE_TYPE_BOOLEAN = 1
Boolean
DISPLAY_VARIABLE_TOGGLE_TYPE_STRING = 2
String
DISPLAY_VARIABLE_TOGGLE_TYPE_INTEGER = 3
Integer
ExtensionType specifies the type of extension.
Used in:
ET_UNDEFINED = 0
EXTENSIONTYPE_UNDEFINED indicates that the extension type is undefined.
ET_EMAIL_ADDRESS = 1
General formats.
ET_MULTI_LINE_STRING = 2
ET_CREATE_RESOURCE = 21
ET_GCE_DISK_IMAGE = 3
GCE related.
ET_GCE_DISK_TYPE = 4
ET_GCE_DISK_SIZE = 5
ET_GCE_MACHINE_TYPE = 6
ET_GCE_NETWORK = 7
ET_GCE_ZONE = 8
ET_GCE_SUBNETWORK = 9
ET_GCE_REGION = 10
ET_GCE_GPU_TYPE = 11
ET_GCE_GPU_COUNT = 12
ET_GCE_EXTERNAL_IP = 13
ET_GCE_IP_FORWARDING = 14
ET_GCE_FIREWALL = 15
ET_GCE_FIREWALL_RANGE = 16
ET_GCE_GENERIC_RESOURCE = 17
ET_GCE_LOCATION = 22
ET_GCS_BUCKET = 18
GCS related.
ET_IAM_SERVICE_ACCOUNT = 19
IAM related.
ET_GKE_CLUSTER = 20
GKE related.
ExternalIPType specifies the type of external IP address.
Used in:
IP_UNSPECIFIED = 0
IP_EPHEMERAL = 1
EPHEMERAL indicates that the external IP address is ephemeral.
IP_STATIC = 2
STATIC indicates that the external IP address is static.
IP_NONE = 3
NONE indicates that an external IP is not assigned.
message
bpmetadata_ui_ext.proto:132GCEDiskSizeExtension specifies the size of a disk for a GCE resource.
Used in:
string disk_type_variable = 1
The allowable range of disk sizes depends on the disk type. This field references another variable from the schema, which must have type GCEDiskType.
@gotags: json:"diskTypeVariable" yaml:"diskTypeVariable"
message
bpmetadata_ui_ext.proto:125GCEDiskTypeExtension specifies the type of disk for a GCE resource.
Used in:
string machine_type_variable = 1
This field references another variable from the schema, which must have type GCEMachineType.
@gotags: json:"machineTypeVariable" yaml:"machineTypeVariable"
message
bpmetadata_ui_ext.proto:163Used in:
string network_variable = 1
NetworkVariable is the name of the network variable that the external IP address belongs to.
@gotags: json:"networkVariable" yaml:"networkVariable"
ExternalIPType type = 2
Type specifies the type of external IP address. Defaults to EPHEMERAL if not specified.
@gotags: json:"type,omitempty" yaml:"type,omitempty"
bool not_configurable = 3
Flag to denote if an external IP should be configurable.
@gotags: json:"notConfigurable,omitempty" yaml:"notConfigurable,omitempty"
bool allow_static_ips = 4
Flag to denote if static IPs are allowed for the external IP.
@gotags: json:"allowStaticIps,omitempty" yaml:"allowStaticIps,omitempty"
message
bpmetadata_ui_ext.proto:186Used in:
string network_variable = 1
NetworkVariable is used to indicate the network variable in the schema this external IP belongs to.
@gotags: json:"networkVariable" yaml:"networkVariable"
message
bpmetadata_ui_ext.proto:192Used in:
string firewall_variable = 1
FirewallVariable is used to indicate the firewall variable with the type GCEFirewall in the schema to which this firewall range belongs to.
@gotags: json:"firewallVariable" yaml:"firewallVariable"
message
bpmetadata_ui_ext.proto:118GCEGPUCountExtension specifies the number of GPUs that should be attached to a machine.
Used in:
string machine_type_variable = 1
This field references another variable from the schema, which must have type GCEMachineType.
@gotags: json:"machineTypeVariable" yaml:"machineTypeVariable"
message
bpmetadata_ui_ext.proto:109GCEGPUTypeExtension specifies a GPU type extension for a GCE resource.
Used in:
string machine_type = 1
MachineType is the name of the machine type that the GPU is attached to.
@gotags: json:"machineType" yaml:"machineType"
repeated string gpu_type = 2
GPUType is the type(s) of GPU that is attached to the machine.
@gotags: json:"gpuType,omitempty" yaml:"gpuType,omitempty"
message
bpmetadata_ui_ext.proto:205Used in:
string resource_variable = 1
GCE resource type to be fetched. This field references another property from the schema, which must have type GCEGenericResource.
@gotags: json:"resourceVariable" yaml:"resourceVariable"
message
bpmetadata_ui_ext.proto:178GCEIPForwardingExtension specifies an IP forwarding extension for a GCE resource.
Used in:
string network_variable = 1
NetworkVariable is the name of the network variable that the IP forwarding belongs to.
@gotags: json:"networkVariable" yaml:"networkVariable"
bool not_configurable = 2
NotConfigurable specifies whether the IP forwarding is configurable. Defaults to false if not specified.
@gotags: json:"notConfigurable,omitempty" yaml:"notConfigurable,omitempty"
message
bpmetadata_ui_ext.proto:82GCELocationExtension specifies a location extension for a Google Compute Engine (GCE) resource.
Used in:
repeated string allowlisted_zones = 1
AllowlistedZones is a list of zones that are allowed for the resource.
@gotags: json:"allowlistedZones,omitempty" yaml:"allowlistedZones,omitempty"
repeated string allowlisted_regions = 2
AllowlistedRegions is a list of regions that are allowed for the resource.
@gotags: json:"allowlistedRegions,omitempty" yaml:"allowlistedRegions,omitempty"
message
bpmetadata_ui_ext.proto:91GCEMachineTypeExtension specifies a machine type extension for a GCE resource.
Used in:
int32 min_cpu = 1
Minimum cpu. Used to filter the list of selectable machine types.
@gotags: json:"minCpu,omitempty" yaml:"minCpu,omitempty"
float min_ram_gb = 2
Minimum ram. Used to filter the list of selectable machine types.
@gotags: json:"minRamGb,omitempty" yaml:"minRamGb,omitempty"
bool disallow_custom_machine_types = 3
If true, custom machine types will not be selectable. More info: https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type
@gotags: json:"disallowCustomMachineTypes,omitempty" yaml:"disallowCustomMachineTypes,omitempty"
string disk_image_property = 4
Disk Image allows us to reference the image that is being used to help provide/gather data such as the image architecture.
@gotags: json:"diskImageProperty,omitempty" yaml:"diskImageProperty,omitempty"
message
bpmetadata_ui_ext.proto:139GCENetworkExtension specifies a network extension for a GCE resource.
Used in:
bool allow_shared_vpcs = 1
AllowSharedVpcs indicates this solution can receive shared VPC selflinks (fully qualified compute links).
@gotags: json:"allowSharedVpcs,omitempty" yaml:"allowSharedVpcs,omitempty"
string machine_type_variable = 2
Used to indicate to which machine type this network interface will be attached to.
@gotags: json:"machineTypeVariable" yaml:"machineTypeVariable"
repeated string labels = 3
Label that will be in front of each Network Interface.
@gotags: json:"labels,omitempty" yaml:"labels,omitempty"
message
bpmetadata_ui_ext.proto:198Used in:
string network_variable = 1
Subnetwork variable requires a network context in order to determine the set of available subnetworks. This field references another variable from the schema, which must have type GCENetwork.
@gotags: json:"networkVariable" yaml:"networkVariable"
message
bpmetadata_ui_ext.proto:217Used in:
string location_variable = 1
GKE Cluster variable to be used for gathering context needed to select/create a GKE Cluster for GKE AI Products.
@gotags: json:"locationVariable" yaml:"locationVariable"
string cluster_creation_variable = 2
Variable that will indicate if we are creating a cluster or using an existing one.
@gotags: json:"clusterCreationVariable" yaml:"clusterCreationVariable"
message
bpmetadata_ui_ext.proto:49An extension for variables defined as part of DisplayVariable. The extension defines Google-specifc metadata necessary for choosing an appropriate input widget or adding restrictions to GCP-specific resources.
Used in:
ExtensionType type = 1
Type specifies the type of extension. Gen: manually-authored
@gotags: json:"type" yaml:"type"
string zone_property = 2
Some properties (e.g. GCE_MACHINE_TYPE) require a zone context in order to determine the set of allowable values. This field references another property from the schema, which must have type GCE_ZONE. Gen: manually-authored
@gotags: json:"zoneProperty,omitempty" yaml:"zoneProperty,omitempty"
optional gce_machine_type = 3
Property-specific extensions. Gen: manually-authored (all property extensions and their child properties)
@gotags: json:"gceMachineType,omitempty" yaml:"gceMachineType,omitempty"
optional gce_disk_size = 4
@gotags: json:"gceDiskSize,omitempty" yaml:"gceDiskSize,omitempty"
optional gce_subnetwork = 5
@gotags: json:"gceSubnetwork,omitempty" yaml:"gceSubnetwork,omitempty"
optional gce_resource = 6
@gotags: json:"gceResource,omitempty" yaml:"gceResource,omitempty"
optional gce_gpu_type = 7
@gotags: json:"gceGpuType,omitempty" yaml:"gceGpuType,omitempty"
optional gce_gpu_count = 8
@gotags: json:"gceGpuCount,omitempty" yaml:"gceGpuCount,omitempty"
optional gce_network = 9
@gotags: json:"gceNetwork,omitempty" yaml:"gceNetwork,omitempty"
optional gce_external_ip = 10
@gotags: json:"gceExternalIp,omitempty" yaml:"gceExternalIp,omitempty"
optional gce_ip_forwarding = 11
@gotags: json:"gceIpForwarding,omitempty" yaml:"gceIpForwarding,omitempty"
optional gce_firewall = 12
@gotags: json:"gceFirewall,omitempty" yaml:"gceFirewall,omitempty"
optional gce_firewall_range = 13
@gotags: json:"gceFirewallRange,omitempty" yaml:"gceFirewallRange,omitempty"
optional gce_zone = 14
@gotags: json:"gceZone,omitempty" yaml:"gceZone,omitempty"
optional gce_region = 15
@gotags: json:"gceRegion,omitempty" yaml:"gceRegion,omitempty"
optional iam_service_account = 16
@gotags: json:"iamServiceAccount,omitempty" yaml:"iamServiceAccount,omitempty"
optional gce_disk_type = 17
@gotags: json:"gceDiskType,omitempty" yaml:"gceDiskType,omitempty"
optional gce_location = 18
@gotags: json:"gceLocation,omitempty" yaml:"gceLocation,omitempty"
optional gke_cluster = 19
@gotags: json:"gkeCluster,omitempty" yaml:"gkeCluster,omitempty"
message
bpmetadata_ui_ext.proto:211Used in:
repeated string roles = 1
List of IAM roles that to grant to a new SA, or the roles to filter existing SAs with.
@gotags: json:"roles" yaml:"roles"
message
bpmetadata.proto:202ProviderVersion defines the required version for a provider.
Used in:
string source = 1
Provider source of form [hostname]/namespace/name. Hostname is optional defaulting to Terraform registry. Gen: auto-generated from required providers block.
@gotags: json:"source,omitempty" yaml:"source,omitempty"
string version = 2
Version constraint string. Gen: auto-generated from required providers block.
@gotags: json:"version,omitempty" yaml:"version,omitempty"
QuotaResourceType defines the type of resource a quota is applied to.
Used in:
QRT_UNDEFINED = 0
QRT_RESOURCE_TYPE_GCE_INSTANCE = 1
QRT_RESOURCE_TYPE_GCE_DISK = 2
message
bpmetadata.proto:37Used in:
string name = 1
Name is the metadata.name field of a Resource Gen: auto-generated
@gotags: json:"name,omitempty" yaml:"name,omitempty"
map<string, string> labels = 2
Labels is the metadata.labels field of a Resource Gen: manually-authored
@gotags: json:"labels,omitempty" yaml:"labels,omitempty"
map<string, string> annotations = 3
Annotations is the metadata.annotations field of a Resource. Gen: auto-generated
@gotags: json:"annotations,omitempty" yaml:"annotations,omitempty"
SoftwareGroupType is a string enum representing the different types of software groups.
Used in:
SG_UNSPECIFIED = 0
UNSPECIFIED is the default value for SoftwareGroupType.
SG_OS = 1
OS is a software group that represents an operating system.
message
bpmetadata_ui.proto:254An item appearing in a list of required or suggested steps.
Used in:
string heading = 1
Summary heading for the item. Required. Accepts string expressions. At most 64 characters. Gen: manually-authored
@gotags: json:"heading" yaml:"heading"
string description = 2
Longer description of the item. At least one description or snippet is required. Accepts string expressions. HTML <code><a href></code> tags only. At most 512 characters. Gen: manually-authored
@gotags: json:"description,omitempty" yaml:"description,omitempty"
string snippet = 3
Fixed-width formatted code snippet. At least one description or snippet is required. Accepts string expressions. UTF-8 text. At most 512 characters. Gen: manually-authored
@gotags: json:"snippet,omitempty" yaml:"snippet,omitempty"
string show_if = 4
If present, this expression determines whether the item is shown. Should be in the form of a Boolean expression e.g. outputs.hasExternalIP where `externalIP` is the output. Gen: manually-authored
@gotags: json:"showIf,omitempty" yaml:"showIf,omitempty"
message
bpmetadata_ui.proto:176Used in:
string label = 1
@gotags: json:"label,omitempty" yaml:"label,omitempty"
string value = 2
@gotags: json:"value,omitempty" yaml:"value,omitempty"