# Cloud KMS V1 Client - Class RetiredResource (2.9.0)

2.9.0 (latest) 2.8.0 2.7.0 2.6.0 2.5.2 2.4.0 2.3.1 2.2.0 2.1.6 2.0.0 1.23.0 1.22.1 1.21.4 1.20.3 1.19.0 1.18.1 1.17.0 1.16.4 1.15.3 Reference documentation and code samples for the Cloud KMS V1 Client class RetiredResource.

A RetiredResource resource represents the record of a deleted
[CryptoKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey). Its purpose is to provide
visibility into retained user data and to prevent reuse of these names for
new [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey).

Generated from protobuf message `google.cloud.kms.v1.RetiredResource`

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `data` | `mixed` |

### getName

Output only. Identifier. The resource name for this
[RetiredResource](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource) in the format
`projects/*/locations/*/retiredResources/*`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Output only. Identifier. The resource name for this
[RetiredResource](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RetiredResource) in the format
`projects/*/locations/*/retiredResources/*`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOriginalResource

Output only. The full resource name of the original
[CryptoKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) that was deleted in the format
`projects/*/locations/*/keyRings/*/cryptoKeys/*`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOriginalResource

Output only. The full resource name of the original
[CryptoKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) that was deleted in the format
`projects/*/locations/*/keyRings/*/cryptoKeys/*`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getResourceType

Output only. The resource type of the original deleted resource.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setResourceType

Output only. The resource type of the original deleted resource.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDeleteTime

Output only. The time at which the original resource was deleted and this
RetiredResource record was created.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasDeleteTime

### clearDeleteTime

### setDeleteTime

Output only. The time at which the original resource was deleted and this
RetiredResource record was created.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |