Reference documentation and code samples for the Google Cloud Design Center V1 Client class TerraformModuleMetadata.
Top-level message representing a Terraform module and its metadata.
Generated from protobuf message google.cloud.designcenter.v1.TerraformModuleMetadata
Namespace
Google \ Cloud \ DesignCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ uri |
string
Optional. The URI of the Terraform module. |
↳ id |
string
Optional. Unique identifier for the module version, e.g., "GoogleCloudPlatform/secret-manager/google/0.9.0" |
↳ owner |
string
Optional. Owner of the module. |
↳ module_namespace |
string
Optional. Namespace for the module, often the organization. |
↳ name |
string
Optional. Name of the module. |
↳ version |
string
Optional. Semantic version of the module. |
↳ provider |
string
Optional. Primary provider used by the module, e.g., "google". |
↳ description |
string
Optional. Description of the module's purpose. |
↳ source |
string
Optional. URL to the source repository. |
↳ tag |
string
Optional. Git tag or ref for this version. |
↳ root |
ModuleDetails
Optional. Details of the root module. |
↳ submodules |
array<ModuleDetails>
Optional. List of submodules within this module. |
↳ examples |
array<ModuleDetails>
Optional. List of examples for this module. |
↳ providers |
string[]
Optional. List of provider names used. |
↳ versions |
string[]
Optional. List of available versions for this module. |
↳ revisions |
string[]
Optional. List of available revisions for this module. |
↳ connections |
array<TerraformInputConnections>
Optional. Terraform input connections. |
getUri
Optional. The URI of the Terraform module.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUri
Optional. The URI of the Terraform module.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Optional. Unique identifier for the module version, e.g., "GoogleCloudPlatform/secret-manager/google/0.9.0"
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Optional. Unique identifier for the module version, e.g., "GoogleCloudPlatform/secret-manager/google/0.9.0"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOwner
Optional. Owner of the module.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOwner
Optional. Owner of the module.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModuleNamespace
Optional. Namespace for the module, often the organization.
| Returns | |
|---|---|
| Type | Description |
string |
|
setModuleNamespace
Optional. Namespace for the module, often the organization.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Optional. Name of the module.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Optional. Name of the module.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersion
Optional. Semantic version of the module.
| Returns | |
|---|---|
| Type | Description |
string |
|
setVersion
Optional. Semantic version of the module.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProvider
Optional. Primary provider used by the module, e.g., "google".
| Returns | |
|---|---|
| Type | Description |
string |
|
setProvider
Optional. Primary provider used by the module, e.g., "google".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the module's purpose.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the module's purpose.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSource
Optional. URL to the source repository.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSource
Optional. URL to the source repository.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTag
Optional. Git tag or ref for this version.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTag
Optional. Git tag or ref for this version.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRoot
Optional. Details of the root module.
| Returns | |
|---|---|
| Type | Description |
ModuleDetails|null |
|
hasRoot
clearRoot
setRoot
Optional. Details of the root module.
| Parameter | |
|---|---|
| Name | Description |
var |
ModuleDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubmodules
Optional. List of submodules within this module.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ModuleDetails> |
|
setSubmodules
Optional. List of submodules within this module.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ModuleDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExamples
Optional. List of examples for this module.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ModuleDetails> |
|
setExamples
Optional. List of examples for this module.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ModuleDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProviders
Optional. List of provider names used.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setProviders
Optional. List of provider names used.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersions
Optional. List of available versions for this module.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setVersions
Optional. List of available versions for this module.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevisions
Optional. List of available revisions for this module.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setRevisions
Optional. List of available revisions for this module.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnections
Optional. Terraform input connections.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<TerraformInputConnections> |
|
setConnections
Optional. Terraform input connections.
| Parameter | |
|---|---|
| Name | Description |
var |
array<TerraformInputConnections>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|