Google Cloud Developer Connect V1 Client - Class DeploymentEvent (0.6.0)

Reference documentation and code samples for the Google Cloud Developer Connect V1 Client class DeploymentEvent.

The DeploymentEvent resource represents the deployment of the artifact within the InsightsConfig resource.

Generated from protobuf message google.cloud.developerconnect.v1.DeploymentEvent

Namespace

Google \ Cloud \ DeveloperConnect \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The name of the DeploymentEvent. This name is provided by Developer Connect insights. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}

↳ create_time Google\Protobuf\Timestamp

Output only. The create time of the DeploymentEvent.

↳ update_time Google\Protobuf\Timestamp

Output only. The update time of the DeploymentEvent.

↳ runtime_config RuntimeConfig

Output only. The runtime configurations where the DeploymentEvent happened.

↳ runtime_deployment_uri string

Output only. The runtime assigned URI of the DeploymentEvent. For GKE, this is the fully qualified replica set uri. e.g. container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/apps/replicasets/{replica-set-id} For Cloud Run, this is the revision name.

↳ state int

Output only. The state of the DeploymentEvent.

↳ artifact_deployments array<ArtifactDeployment>

Output only. The artifact deployments of the DeploymentEvent. Each artifact deployment contains the artifact uri and the runtime configuration uri. For GKE, this would be all the containers images that are deployed in the pod.

↳ deploy_time Google\Protobuf\Timestamp

Output only. The time at which the DeploymentEvent was deployed. This would be the min of all ArtifactDeployment deploy_times.

↳ undeploy_time Google\Protobuf\Timestamp

Output only. The time at which the DeploymentEvent was undeployed, all artifacts are considered undeployed once this time is set. This would be the max of all ArtifactDeployment undeploy_times. If any ArtifactDeployment is still active (i.e. does not have an undeploy_time), this field will be empty.

getName

Identifier. The name of the DeploymentEvent. This name is provided by Developer Connect insights. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}

Returns
Type Description
string

setName

Identifier. The name of the DeploymentEvent. This name is provided by Developer Connect insights. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The create time of the DeploymentEvent.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The create time of the DeploymentEvent.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The update time of the DeploymentEvent.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update time of the DeploymentEvent.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRuntimeConfig

Output only. The runtime configurations where the DeploymentEvent happened.

Returns
Type Description
RuntimeConfig|null

hasRuntimeConfig

clearRuntimeConfig

setRuntimeConfig

Output only. The runtime configurations where the DeploymentEvent happened.

Parameter
Name Description
var RuntimeConfig
Returns
Type Description
$this

getRuntimeDeploymentUri

Output only. The runtime assigned URI of the DeploymentEvent.

For GKE, this is the fully qualified replica set uri. e.g. container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/apps/replicasets/{replica-set-id} For Cloud Run, this is the revision name.

Returns
Type Description
string

setRuntimeDeploymentUri

Output only. The runtime assigned URI of the DeploymentEvent.

For GKE, this is the fully qualified replica set uri. e.g. container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/apps/replicasets/{replica-set-id} For Cloud Run, this is the revision name.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The state of the DeploymentEvent.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the DeploymentEvent.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getArtifactDeployments

Output only. The artifact deployments of the DeploymentEvent. Each artifact deployment contains the artifact uri and the runtime configuration uri. For GKE, this would be all the containers images that are deployed in the pod.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setArtifactDeployments

Output only. The artifact deployments of the DeploymentEvent. Each artifact deployment contains the artifact uri and the runtime configuration uri. For GKE, this would be all the containers images that are deployed in the pod.

Parameter
Name Description
var array<ArtifactDeployment>
Returns
Type Description
$this

getDeployTime

Output only. The time at which the DeploymentEvent was deployed.

This would be the min of all ArtifactDeployment deploy_times.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeployTime

clearDeployTime

setDeployTime

Output only. The time at which the DeploymentEvent was deployed.

This would be the min of all ArtifactDeployment deploy_times.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUndeployTime

Output only. The time at which the DeploymentEvent was undeployed, all artifacts are considered undeployed once this time is set. This would be the max of all ArtifactDeployment undeploy_times. If any ArtifactDeployment is still active (i.e. does not have an undeploy_time), this field will be empty.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUndeployTime

clearUndeployTime

setUndeployTime

Output only. The time at which the DeploymentEvent was undeployed, all artifacts are considered undeployed once this time is set. This would be the max of all ArtifactDeployment undeploy_times. If any ArtifactDeployment is still active (i.e. does not have an undeploy_time), this field will be empty.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this