Google Cloud Ces V1 Client - Class Deployment (0.3.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class Deployment.

A deployment represents an immutable, queryable version of the app.

It is used to deploy an app version with a specific channel profile.

Generated from protobuf message google.cloud.ces.v1.Deployment

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`↳ display_name`	`string` Required. Display name of the deployment.
`↳ app_version`	`string` Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
`↳ channel_profile`	`ChannelProfile` Required. The channel profile used in the deployment.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this deployment was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this deployment was last updated.
`↳ etag`	`string` Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
`↳ experiment_config`	`ExperimentConfig` Optional. Experiment configuration for the deployment.
`↳ whatsapp_credentials`	`WhatsAppCredentials` Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile.
`↳ instagram_credentials`	`InstagramCredentials` Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile.

getName

Identifier. The resource name of the deployment.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Returns
Type	Description
`string`

setName

Identifier. The resource name of the deployment.

Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. Display name of the deployment.

Returns
Type	Description
`string`

setDisplayName

Required. Display name of the deployment.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAppVersion

Optional. The resource name of the app version to deploy.

Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} Use projects/{project}/locations/{location}/apps/{app}/versions/- to use the draft app.

Returns
Type	Description
`string`

setAppVersion

Optional. The resource name of the app version to deploy.

Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} Use projects/{project}/locations/{location}/apps/{app}/versions/- to use the draft app.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getChannelProfile

Required. The channel profile used in the deployment.

Returns
Type	Description
`ChannelProfile\|null`

hasChannelProfile

clearChannelProfile

setChannelProfile

Required. The channel profile used in the deployment.

Parameter
Name	Description
`var`	`ChannelProfile`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when this deployment was created.

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this deployment was created.

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

Returns
Type	Description
`$this`

getUpdateTime

Output only. Timestamp when this deployment was last updated.

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

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this deployment was last updated.

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

Returns
Type	Description
`$this`

getEtag

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Returns
Type	Description
`string`

setEtag