Google Cloud Design Center V1 Client - Class Application (0.1.0)

Reference documentation and code samples for the Google Cloud Design Center V1 Client class Application.

Represents the application resource.

Generated from protobuf message google.cloud.designcenter.v1.Application

Namespace

Google \ Cloud \ DesignCenter \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The name of the application. Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}
↳ create_time	Google\Protobuf\Timestamp Output only. Create timestamp.
↳ update_time	Google\Protobuf\Timestamp Output only. Update timestamp.
↳ source	DeploymentSource Required. The application deployment source.
↳ app_parameters	array<Parameter> Optional. A list of parameters to attach to the deployment source object, which is a catalog entry or application template snapshot.
↳ component_parameters	array<ComponentParameters> Optional. A list of component parameters to associate with the application.
↳ service_account	string Optional. Your own service account that you use to deploy an application.
↳ display_name	string Optional. Display name of the application.
↳ description	string Optional. Description of the application.
↳ attributes	Google\Cloud\AppHub\V1\Attributes Optional. Attributes of the application.
↳ scope	Google\Cloud\AppHub\V1\Scope Required. Scope of the application.
↳ import_existing_resources	bool Optional. Import existing resources into the application.
↳ preview_reference	string Output only. Preview reference for the application.
↳ deployment_revision	string Output only. [Output only] Optional Infra Manager deployment Id with revision
↳ apphub_application	string Output only. The App Hub App associated with the application.
↳ serialized_application_template	SerializedApplicationTemplate Output only. [Output only] Serialized application template.
↳ state	int Output only. Deployment state of the application.
↳ deployment_metadata	DeploymentMetadata Output only. Deployment metadata of the application.
↳ project_parameters	array<ProjectParameters> Output only. List of project parameters for the application.
↳ deployment_region	string Optional. The region where the application is deployed.
↳ updated_template_revision	UpdatedTemplateRevision Output only. The updated template revision because of which the application is outdated.
↳ deployment_project	string Optional. Deployment project of the application.
↳ connection_configs	array<ConnectionConfig> Optional. Connection configuration for the application.
↳ artifact_location	ArtifactLocation Output only. Details of the location where the IaC for this application was last successfully exported.
↳ type	int Optional. The type of the application.
↳ deployment_target	DeploymentTarget Optional. The deployment target of the application.
↳ composition_type	int Output only. The composition type of the application: STANDARD OR COMPOSITE.
↳ composite_application_parameters	CompositeApplicationParameters Optional. Parameters that are required for composite applications.
↳ deployment_group_metadata	DeploymentGroupMetadata Output only. The deployment group metadata of the application. This is applicable only for composite applications.
↳ params_update_strategy	int Optional. Specifies the strategy to use when updating the application parameters while updating the application template revision.
↳ roles_apis_config	array<RolesAndApisConfig> Optional. Project-specific configurations required for application deployment, including IAM roles and APIs. The list can contain up to 100 items.
↳ template_metadata	TFBlueprintMetadata Output only. The input output variables parsed from the imported terraform code.
↳ iac_source	int Output only. Indicates the IaC source format of this application.

getName

Identifier. The name of the application.

Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}

Returns
Type	Description
string

setName

Identifier. The name of the application.

Format: projects/{project}/locations/{location}/spaces/{space}/applications/{application}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Create timestamp.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create timestamp.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Update timestamp.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update timestamp.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getSource

Required. The application deployment source.

Returns
Type	Description
DeploymentSource|null

hasSource

clearSource

setSource

Required. The application deployment source.

Parameter
Name	Description
var	DeploymentSource

Returns
Type	Description
$this

getAppParameters

Optional. A list of parameters to attach to the deployment source object, which is a catalog entry or application template snapshot.

Returns
Type	Description
Google\Protobuf\RepeatedField<Parameter>

setAppParameters

Optional. A list of parameters to attach to the deployment source object, which is a catalog entry or application template snapshot.

Parameter
Name	Description
var	array<Parameter>

Returns
Type	Description
$this

getComponentParameters

Optional. A list of component parameters to associate with the application.

Returns
Type	Description
Google\Protobuf\RepeatedField<ComponentParameters>

setComponentParameters

Optional. A list of component parameters to associate with the application.

Parameter
Name	Description
var	array<ComponentParameters>

Returns
Type	Description
$this

getServiceAccount

Optional. Your own service account that you use to deploy an application.

Returns
Type	Description
string

setServiceAccount

Optional. Your own service account that you use to deploy an application.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Optional. Display name of the application.

Returns
Type	Description
string

setDisplayName

Optional. Display name of the application.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Optional. Description of the application.

Returns
Type	Description
string

setDescription

Optional. Description of the application.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAttributes

Optional. Attributes of the application.

Returns
Type	Description
Google\Cloud\AppHub\V1\Attributes|null

hasAttributes

clearAttributes

setAttributes

Optional. Attributes of the application.

Parameter
Name	Description
var	Google\Cloud\AppHub\V1\Attributes

Returns
Type	Description
$this

getScope

Required. Scope of the application.

Returns
Type	Description
Google\Cloud\AppHub\V1\Scope|null

hasScope

clearScope

setScope

Required. Scope of the application.

Parameter
Name	Description
var	Google\Cloud\AppHub\V1\Scope

Returns
Type	Description
$this

getImportExistingResources

Optional. Import existing resources into the application.

Returns
Type	Description
bool

setImportExistingResources

Optional. Import existing resources into the application.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getPreviewReference

Output only. Preview reference for the application.

Returns
Type	Description
string

setPreviewReference

Output only. Preview reference for the application.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeploymentRevision

Output only. [Output only] Optional Infra Manager deployment Id with revision

Returns
Type	Description
string

setDeploymentRevision

Output only. [Output only] Optional Infra Manager deployment Id with revision

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getApphubApplication

Output only. The App Hub App associated with the application.

Returns
Type	Description
string

setApphubApplication

Output only. The App Hub App associated with the application.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSerializedApplicationTemplate

Output only. [Output only] Serialized application template.

Returns
Type	Description
SerializedApplicationTemplate|null

hasSerializedApplicationTemplate

clearSerializedApplicationTemplate

setSerializedApplicationTemplate

Output only. [Output only] Serialized application template.

Parameter
Name	Description
var	SerializedApplicationTemplate

Returns
Type	Description
$this

getState

Output only. Deployment state of the application.

Returns
Type	Description
int	Enum of type State.

setState

Output only. Deployment state of the application.

Parameter
Name	Description
var	int Enum of type State.

Returns
Type	Description
$this

getDeploymentMetadata

Output only. Deployment metadata of the application.

Returns
Type	Description
DeploymentMetadata|null

hasDeploymentMetadata

clearDeploymentMetadata

setDeploymentMetadata

Output only. Deployment metadata of the application.

Parameter
Name	Description
var	DeploymentMetadata

Returns
Type	Description
$this

getProjectParameters

Output only. List of project parameters for the application.

Returns
Type	Description
Google\Protobuf\RepeatedField<ProjectParameters>

setProjectParameters

Output only. List of project parameters for the application.

Parameter
Name	Description
var	array<ProjectParameters>

Returns
Type	Description
$this

getDeploymentRegion

Optional. The region where the application is deployed.

Returns
Type	Description
string

setDeploymentRegion

Optional. The region where the application is deployed.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUpdatedTemplateRevision

Output only. The updated template revision because of which the application is outdated.

Returns
Type	Description
UpdatedTemplateRevision|null

hasUpdatedTemplateRevision

clearUpdatedTemplateRevision

setUpdatedTemplateRevision

Output only. The updated template revision because of which the application is outdated.

Parameter
Name	Description
var	UpdatedTemplateRevision

Returns
Type	Description
$this

getDeploymentProject

Optional. Deployment project of the application.

Returns
Type	Description
string

setDeploymentProject

Optional. Deployment project of the application.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getConnectionConfigs

Optional. Connection configuration for the application.

Returns
Type	Description
Google\Protobuf\RepeatedField<ConnectionConfig>

setConnectionConfigs

Optional. Connection configuration for the application.

Parameter
Name	Description
var	array<ConnectionConfig>

Returns
Type	Description
$this

getArtifactLocation

Output only. Details of the location where the IaC for this application was last successfully exported.

Returns
Type	Description
ArtifactLocation|null

hasArtifactLocation

clearArtifactLocation

setArtifactLocation

Output only. Details of the location where the IaC for this application was last successfully exported.

Parameter
Name	Description
var	ArtifactLocation

Returns
Type	Description
$this

getType

Optional. The type of the application.

Returns
Type	Description
int	Enum of type ApplicationType.

setType

Optional. The type of the application.

Parameter
Name	Description
var	int Enum of type ApplicationType.

Returns
Type	Description
$this

getDeploymentTarget

Optional. The deployment target of the application.

Returns
Type	Description
DeploymentTarget|null

hasDeploymentTarget

clearDeploymentTarget

setDeploymentTarget

Optional. The deployment target of the application.

Parameter
Name	Description
var	DeploymentTarget

Returns
Type	Description
$this

getCompositionType

Output only. The composition type of the application: STANDARD OR COMPOSITE.

Returns
Type	Description
int	Enum of type ApplicationCompositionType.

setCompositionType

Output only. The composition type of the application: STANDARD OR COMPOSITE.

Parameter
Name	Description
var	int Enum of type ApplicationCompositionType.

Returns
Type	Description
$this

getCompositeApplicationParameters

Optional. Parameters that are required for composite applications.

Returns
Type	Description
CompositeApplicationParameters|null

hasCompositeApplicationParameters

clearCompositeApplicationParameters

setCompositeApplicationParameters

Optional. Parameters that are required for composite applications.

Parameter
Name	Description
var	CompositeApplicationParameters

Returns
Type	Description
$this

getDeploymentGroupMetadata

Output only. The deployment group metadata of the application. This is applicable only for composite applications.

Returns
Type	Description
DeploymentGroupMetadata|null

hasDeploymentGroupMetadata

clearDeploymentGroupMetadata

setDeploymentGroupMetadata

Output only. The deployment group metadata of the application. This is applicable only for composite applications.

Parameter
Name	Description
var	DeploymentGroupMetadata

Returns
Type	Description
$this

getParamsUpdateStrategy

Optional. Specifies the strategy to use when updating the application parameters while updating the application template revision.

Returns
Type	Description
int	Enum of type UpdateStrategy.

setParamsUpdateStrategy

Optional. Specifies the strategy to use when updating the application parameters while updating the application template revision.

Parameter
Name	Description
var	int Enum of type UpdateStrategy.

Returns
Type	Description
$this

getRolesApisConfig

Optional. Project-specific configurations required for application deployment, including IAM roles and APIs. The list can contain up to 100 items.

Returns
Type	Description
Google\Protobuf\RepeatedField<RolesAndApisConfig>

setRolesApisConfig

Optional. Project-specific configurations required for application deployment, including IAM roles and APIs. The list can contain up to 100 items.

Parameter
Name	Description
var	array<RolesAndApisConfig>

Returns
Type	Description
$this

getTemplateMetadata

Output only. The input output variables parsed from the imported terraform code.

Returns
Type	Description
TFBlueprintMetadata|null

hasTemplateMetadata

clearTemplateMetadata

setTemplateMetadata

Output only. The input output variables parsed from the imported terraform code.

Parameter
Name	Description
var	TFBlueprintMetadata

Returns
Type	Description
$this

getIacSource

Output only. Indicates the IaC source format of this application.

Returns
Type	Description
int	Enum of type IACSource.

setIacSource

Output only. Indicates the IaC source format of this application.

Parameter
Name	Description
var	int Enum of type IACSource.

Returns
Type	Description
$this