Reference documentation and code samples for the Google Cloud Design Center V1 Client class Component.
Component resource.
Generated from protobuf message google.cloud.designcenter.v1.Component
Namespace
Google \ Cloud \ DesignCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The component name. |
↳ shared_template_revision_uri |
string
Required. Immutable. The shared template used to generate the component. |
↳ parameters |
array<Parameter>
Optional. The component parameters. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The component creation timestamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The component update timestamp. |
↳ roles |
string[]
Output only. IAM roles required by the service account to deploy the component. |
↳ apis |
string[]
Output only. APIs required to be enabled to deploy the component, in the form of "*.googleapis.com". |
↳ display_name |
string
Optional. The component display name. |
↳ connections_parameters |
array<ConnectionParameters>
Output only. The connection parameters of the component. |
↳ component_parameter_schema |
array<ComponentParameterSchema>
Output only. The component parameter schema, which includes possible parameter values. values. |
↳ application_info |
ComponentApplicationInfo
Optional. The application associated with the component. |
↳ use_as_root_module |
bool
Optional. Whether the component is exported as a separate terraform root module in a composite application template. If this is false, then native components will be exported as a submodule of a separate terraform root module. |
↳ input_variable_aliases |
array<InputVariableAlias>
Optional. Input variable aliases defined on this live component. |
↳ application_template_revision_uri |
string
Optional. The application template revision used to generate the component. |
getName
Identifier. The component name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The component name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSharedTemplateRevisionUri
Required. Immutable. The shared template used to generate the component.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSharedTemplateRevisionUri
Required. Immutable. The shared template used to generate the component.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameters
Optional. The component parameters.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Parameter> |
|
setParameters
Optional. The component parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Parameter>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The component creation timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The component creation timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The component update timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The component update timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRoles
Output only. IAM roles required by the service account to deploy the component.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setRoles
Output only. IAM roles required by the service account to deploy the component.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApis
Output only. APIs required to be enabled to deploy the component, in the form of "*.googleapis.com".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setApis
Output only. APIs required to be enabled to deploy the component, in the form of "*.googleapis.com".
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. The component display name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. The component display name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionsParameters
Output only. The connection parameters of the component.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ConnectionParameters> |
|
setConnectionsParameters
Output only. The connection parameters of the component.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ConnectionParameters>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComponentParameterSchema
Output only. The component parameter schema, which includes possible parameter values. values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ComponentParameterSchema> |
|
setComponentParameterSchema
Output only. The component parameter schema, which includes possible parameter values. values.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ComponentParameterSchema>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApplicationInfo
Optional. The application associated with the component.
| Returns | |
|---|---|
| Type | Description |
ComponentApplicationInfo|null |
|
hasApplicationInfo
clearApplicationInfo
setApplicationInfo
Optional. The application associated with the component.
| Parameter | |
|---|---|
| Name | Description |
var |
ComponentApplicationInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUseAsRootModule
Optional. Whether the component is exported as a separate terraform root module in a composite application template. If this is false, then native components will be exported as a submodule of a separate terraform root module.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUseAsRootModule
Optional. Whether the component is exported as a separate terraform root module in a composite application template. If this is false, then native components will be exported as a submodule of a separate terraform root module.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputVariableAliases
Optional. Input variable aliases defined on this live component.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<InputVariableAlias> |
|
setInputVariableAliases
Optional. Input variable aliases defined on this live component.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InputVariableAlias>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApplicationTemplateRevisionUri
Optional. The application template revision used to generate the component.
| Returns | |
|---|---|
| Type | Description |
string |
|
setApplicationTemplateRevisionUri
Optional. The application template revision used to generate the component.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|