# Interface KeyHandleOrBuilder (2.96.0)

2.96.0 (latest) 2.94.0 2.91.0 2.90.0 2.88.0 2.86.0 2.85.0 2.84.0 2.83.0 2.81.0 2.79.0 2.78.0 2.77.0 2.76.0 2.75.0 2.73.0 2.71.0 2.70.0 2.67.0 2.66.0 2.65.0 2.63.0 2.62.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.8 2.5.3 2.4.4 2.3.1

    public interface KeyHandleOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getKmsKey()

    public abstract String getKmsKey()

Output only. Name of a CryptoKey that has
been provisioned for Customer Managed Encryption Key (CMEK) use in the
KeyHandle project and location for the
requested resource type. The CryptoKey
project will reflect the value configured in the
AutokeyConfig on the resource
project's ancestor folder at the time of the
KeyHandle creation. If more than one
ancestor folder has a configured
AutokeyConfig, the nearest of these
configurations is used.

`
string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The kmsKey. |

### getKmsKeyBytes()

    public abstract ByteString getKmsKeyBytes()

Output only. Name of a CryptoKey that has
been provisioned for Customer Managed Encryption Key (CMEK) use in the
KeyHandle project and location for the
requested resource type. The CryptoKey
project will reflect the value configured in the
AutokeyConfig on the resource
project's ancestor folder at the time of the
KeyHandle creation. If more than one
ancestor folder has a configured
AutokeyConfig, the nearest of these
configurations is used.

`
string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for kmsKey. |

### getName()

    public abstract String getName()

Identifier. Name of the KeyHandle
resource, e.g.
`projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.

`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. |

### getNameBytes()

    public abstract ByteString getNameBytes()

Identifier. Name of the KeyHandle
resource, e.g.
`projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.

`string name = 1 [(.google.api.field_behavior) = IDENTIFIER];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. |

### getResourceTypeSelector()

    public abstract String getResourceTypeSelector()

Required. Indicates the resource type that the resulting
CryptoKey is meant to protect, e.g.
`{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource
types.

`string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The resourceTypeSelector. |

### getResourceTypeSelectorBytes()

    public abstract ByteString getResourceTypeSelectorBytes()

Required. Indicates the resource type that the resulting
CryptoKey is meant to protect, e.g.
`{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource
types.

`string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for resourceTypeSelector. |