Google Cloud Telco Automation V1 Client - Class Blueprint (1.0.2)

Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class Blueprint.

A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved.

On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

Generated from protobuf message google.cloud.telcoautomation.v1.Blueprint

Namespace

Google \ Cloud \ TelcoAutomation \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` The name of the blueprint. If unspecified, the name will be autogenerated from server side. Name of the blueprint must not contain `@` character.
`↳ revision_id`	`string` Output only. Immutable. The revision ID of the blueprint. A new revision is committed whenever a blueprint is approved.
`↳ source_blueprint`	`string` Required. Immutable. The public blueprint ID from which this blueprint was created.
`↳ revision_create_time`	`Google\Protobuf\Timestamp` Output only. The timestamp that the revision was created.
`↳ approval_state`	`int` Output only. Approval state of the blueprint (DRAFT, PROPOSED, APPROVED)
`↳ display_name`	`string` Optional. Human readable name of a Blueprint.
`↳ repository`	`string` Output only. Name of the repository where the blueprint files are stored.
`↳ files`	`array<File>` Optional. Files present in a blueprint. When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Blueprint creation time.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when the blueprint was updated.
`↳ source_provider`	`string` Output only. Source provider is the author of a public blueprint, from which this blueprint is created.
`↳ deployment_level`	`int` Output only. DeploymentLevel of a blueprint signifies where the blueprint will be applied. e.g. [HYDRATION, SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT]
`↳ rollback_support`	`bool` Output only. Indicates if the deployment created from this blueprint can be rolled back.

getName

The name of the blueprint. If unspecified, the name will be autogenerated from server side. Name of the blueprint must not contain @ character.

Returns
Type	Description
`string`

setName

The name of the blueprint. If unspecified, the name will be autogenerated from server side. Name of the blueprint must not contain @ character.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRevisionId

Output only. Immutable. The revision ID of the blueprint.

A new revision is committed whenever a blueprint is approved.

Returns
Type	Description
`string`

setRevisionId

Output only. Immutable. The revision ID of the blueprint.

A new revision is committed whenever a blueprint is approved.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceBlueprint

Required. Immutable. The public blueprint ID from which this blueprint was created.

Returns
Type	Description
`string`

setSourceBlueprint

Required. Immutable. The public blueprint ID from which this blueprint 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`

getApprovalState

Output only. Approval state of the blueprint (DRAFT, PROPOSED, APPROVED)

Returns
Type	Description
`int`

setApprovalState

Output only. Approval state of the blueprint (DRAFT, PROPOSED, APPROVED)

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDisplayName

Optional. Human readable name of a Blueprint.

Returns
Type	Description
`string`

setDisplayName

Optional. Human readable name of a Blueprint.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRepository

Output only. Name of the repository where the blueprint files are stored.

Returns
Type	Description
`string`

setRepository

Output only. Name of the repository where the blueprint files are stored.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFiles

Optional. Files present in a blueprint.

When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setFiles

Optional. Files present in a blueprint.

When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

Parameter
Name	Description
`var`	`array<File>`

Returns
Type	Description
`$this`

getLabels

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. Blueprint creation time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Blueprint creation time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The timestamp when the blueprint was updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the blueprint 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 blueprint is created.

Returns
Type	Description
`string`

setSourceProvider

Output only. Source provider is the author of a public blueprint, from which this blueprint is created.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeploymentLevel

Output only. DeploymentLevel of a blueprint signifies where the blueprint will be applied. e.g. [HYDRATION, SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT]

Returns
Type	Description
`int`

setDeploymentLevel

Output only. DeploymentLevel of a blueprint signifies where the blueprint will be applied. e.g. [HYDRATION, SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT]

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getRollbackSupport

Output only. Indicates if the deployment created from this blueprint can be rolled back.

Returns
Type	Description
`bool`

setRollbackSupport

Output only. Indicates if the deployment created from this blueprint can be rolled back.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`