Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class Deployment.
Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.
Generated from protobuf message google.cloud.telcoautomation.v1.Deployment
Namespace
Google \ Cloud \ TelcoAutomation \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the deployment. |
↳ revision_id |
string
Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever a change in deployment is applied. |
↳ source_blueprint_revision |
string
Required. The blueprint revision from which this deployment was created. |
↳ revision_create_time |
Google\Protobuf\Timestamp
Output only. The timestamp that the revision was created. |
↳ state |
int
Output only. State of the deployment (DRAFT, APPLIED, DELETING). |
↳ display_name |
string
Optional. Human readable name of a Deployment. |
↳ repository |
string
Output only. Name of the repository where the deployment package files are stored. |
↳ files |
array<Google\Cloud\TelcoAutomation\V1\File>
Optional. Files present in a deployment. When invoking UpdateDeployment API, only the modified files should be included in this. Files that are not included in the update of a deployment will not be changed. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels are key-value attributes that can be set on a deployment resource by the user. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Deployment creation time. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the deployment was updated. |
↳ source_provider |
string
Output only. Source provider is the author of a public blueprint, from which this deployment is created. |
↳ workload_cluster |
string
Optional. Immutable. The WorkloadCluster on which to create the Deployment. This field should only be passed when the deployment_level of the source blueprint specifies deployments on workload clusters e.g. WORKLOAD_CLUSTER_DEPLOYMENT. |
↳ deployment_level |
int
Output only. Attributes to where the deployment can inflict changes. The value can only be [SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT]. |
↳ rollback_support |
bool
Output only. Indicates if the deployment can be rolled back, exported from public blueprint. |
getName
The name of the deployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The name of the deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevisionId
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever a change in deployment is applied.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRevisionId
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever a change in deployment is applied.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceBlueprintRevision
Required. The blueprint revision from which this deployment was created.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSourceBlueprintRevision
Required. The blueprint revision from which this deployment was created.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevisionCreateTime
Output only. The timestamp that the revision was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasRevisionCreateTime
clearRevisionCreateTime
setRevisionCreateTime
Output only. The timestamp that the revision was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the deployment (DRAFT, APPLIED, DELETING).
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the deployment (DRAFT, APPLIED, DELETING).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Human readable name of a Deployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Human readable name of a Deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRepository
Output only. Name of the repository where the deployment package files are stored.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRepository
Output only. Name of the repository where the deployment package files are stored.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFiles
Optional. Files present in a deployment.
When invoking UpdateDeployment API, only the modified files should be included in this. Files that are not included in the update of a deployment will not be changed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFiles
Optional. Files present in a deployment.
When invoking UpdateDeployment API, only the modified files should be included in this. Files that are not included in the update of a deployment will not be changed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\TelcoAutomation\V1\File>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels are key-value attributes that can be set on a deployment resource by the user.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels are key-value attributes that can be set on a deployment resource by the user.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Deployment creation time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Deployment creation time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the deployment was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the deployment was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceProvider
Output only. Source provider is the author of a public blueprint, from which this deployment is created.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSourceProvider
Output only. Source provider is the author of a public blueprint, from which this deployment is created.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkloadCluster
Optional. Immutable. The WorkloadCluster on which to create the Deployment.
This field should only be passed when the deployment_level of the source blueprint specifies deployments on workload clusters e.g. WORKLOAD_CLUSTER_DEPLOYMENT.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWorkloadCluster
Optional. Immutable. The WorkloadCluster on which to create the Deployment.
This field should only be passed when the deployment_level of the source blueprint specifies deployments on workload clusters e.g. WORKLOAD_CLUSTER_DEPLOYMENT.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentLevel
Output only. Attributes to where the deployment can inflict changes. The value can only be [SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT].
| Returns | |
|---|---|
| Type | Description |
int |
|
setDeploymentLevel
Output only. Attributes to where the deployment can inflict changes. The value can only be [SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT].
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRollbackSupport
Output only. Indicates if the deployment can be rolled back, exported from public blueprint.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRollbackSupport
Output only. Indicates if the deployment can be rolled back, exported from public blueprint.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|