cloud.google.com/go/kms v1.35.0: kmspb.CryptoKeyVersion_CryptoKeyVersionState_name

# Google Cloud KMS CryptoKeyVersion State Name Mapping

This sample demonstrates and verifies the enum-to-name mapping provided by `cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name` in package `pkg:golang/cloud.google.com/go/kms@v1.35.0`.

## Verified Behaviors

1. **Enum to Name Mapping**:
   - `kmspb.CryptoKeyVersion_CryptoKeyVersionState_name` maps each defined `CryptoKeyVersion_CryptoKeyVersionState` integer value to its canonical protobuf identifier string.
   - Verified mapping values include:
     - `CRYPTO_KEY_VERSION_STATE_UNSPECIFIED` (0)
     - `ENABLED` (1)
     - `DISABLED` (2)
     - `DESTROYED` (3)
     - `DESTROY_SCHEDULED` (4)
     - `PENDING_GENERATION` (5)
     - `PENDING_IMPORT` (6)
     - `IMPORT_FAILED` (7)
     - `GENERATION_FAILED` (8)
     - `PENDING_EXTERNAL_DESTRUCTION` (9)
     - `EXTERNAL_DESTRUCTION_FAILED` (10)

2. **Undefined Enum Handling**:
   - Querying `CryptoKeyVersion_CryptoKeyVersionState_name` with an undefined int32 key returns `ok == false` and the empty string.

3. **Bidirectional Mapping Consistency**:
   - Every key-value pair in `CryptoKeyVersion_CryptoKeyVersionState_name` matches its reverse lookup in `CryptoKeyVersion_CryptoKeyVersionState_value`.

4. **Integration with Message Struct**:
   - The state returned by `CryptoKeyVersion.GetState()` resolves properly in `CryptoKeyVersion_CryptoKeyVersionState_name`.

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name in pkg:golang/cloud.google.com/go/kms@v1.35.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/cloud.google.com/go/kms@v1.35.0
Demonstrate these symbols/APIs:
  - cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:b39ed6b5f38a276d23d26b5d411af0eade666b53fd1b1cb43478b30a2e08dd06","contract":["CryptoKeyVersion_CryptoKeyVersionState_name maps every defined CryptoKeyVersion_CryptoKeyVersionState enum constant to its protobuf string identifier.","CryptoKeyVersion_CryptoKeyVersionState_name returns the expected string name for ENABLED, DISABLED, DESTROYED, and PENDING_GENERATION states.","CryptoKeyVersion_CryptoKeyVersionState_value maps protobuf enum names back to their corresponding int32 values.","CryptoKeyVersion.GetState returns a CryptoKeyVersion_CryptoKeyVersionState that resolves in CryptoKeyVersion_CryptoKeyVersionState_name.","CryptoKeyVersion_CryptoKeyVersionState_name lookup with an undefined state returns empty string and false."],"goal":"verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name in pkg:golang/cloud.google.com/go/kms@v1.35.0","kind":"HOW","packages":["pkg:golang/cloud.google.com/go/kms@v1.35.0"],"schemaVersion":1,"symbols":["cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/cloud.google.com/go/kms@v1.35.0"],"schemaVersion":1,"subject":"pkg:golang/cloud.google.com/go/kms@v1.35.0","symbols":["cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name"],"verifierAdapter":"golang@1"}

module sample

go 1.26.0

require cloud.google.com/go/kms v1.35.0

require (
	cloud.google.com/go/longrunning v1.2.0 // indirect
	golang.org/x/net v0.58.0 // indirect
	golang.org/x/sys v0.47.0 // indirect
	golang.org/x/text v0.41.0 // indirect
	google.golang.org/genproto/googleapis/api v0.0.0-20260630182238-925bb5da69e7 // indirect
	google.golang.org/genproto/googleapis/rpc v0.0.0-20260630182238-925bb5da69e7 // indirect
	google.golang.org/grpc v1.83.2 // indirect
	google.golang.org/protobuf v1.36.11 // indirect
)

cloud.google.com/go/kms v1.35.0 h1:nJ/ktaqspx1nPM9vIcO0SHbhqCAm8nvAxL1siuVgKm0=
cloud.google.com/go/kms v1.35.0/go.mod h1:0++71pIHvJL+GmMa8K4jOWFq7gNOX3jm2PRMSJwTKJw=
cloud.google.com/go/longrunning v1.2.0 h1:WjYH3YHBGCxGJP9M4dWGHBfXr/cFIjMkNgWcJj7/iMM=
cloud.google.com/go/longrunning v1.2.0/go.mod h1:5KMQALFGOCtFoi2xSOA1u3H7WKlhmckgiyFw7+LGQp0=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
go.opentelemetry.io/otel v1.44.0 h1:JjwHmHpA4iZ3wBxluu2fbbE7j4kqlE8jXyAyPXH7HqU=
go.opentelemetry.io/otel v1.44.0/go.mod h1:BMgjTHL9WPRlRjL2oZCBTL4whCGtXch2H4BhOPIAyYc=
go.opentelemetry.io/otel/metric v1.44.0 h1:1w0gILTcHdr3YI+ixLyjemwrVnsMURbTZFrSYCdDdmc=
go.opentelemetry.io/otel/metric v1.44.0/go.mod h1:8O7hanEPBNgEMmybD3s2VBKcgWOCsA6tzHBPODAiquo=
go.opentelemetry.io/otel/sdk v1.44.0 h1:nHYwb9lK+fJPU/dnT6s7W7Z8itMWyqrnVfbheVYrZ58=
go.opentelemetry.io/otel/sdk v1.44.0/go.mod h1:Osuydd3Se74nqjAKxid74N5eC+jfEqfTegHRnq58oK0=
go.opentelemetry.io/otel/sdk/metric v1.44.0 h1:3LlKgI+VjbVsjNRFZJZAJ30WjXC5VkNRks6si09iEfI=
go.opentelemetry.io/otel/sdk/metric v1.44.0/go.mod h1:5B5pMARnXxKhltooO4xUuCBorl65a4EpnTalObqOigA=
go.opentelemetry.io/otel/trace v1.44.0 h1:jxF5CsGYCe74MCRx2X4g7WsY/VBKRqqpNvXlX/6gtIk=
go.opentelemetry.io/otel/trace v1.44.0/go.mod h1:oLl1jrMQAVo6v3GAggN+1VH9VIz9iUSvW53sW1Q8PIE=
golang.org/x/net v0.58.0 h1:ynWG7rqYi4ccpTEuPZ2QGWHktVEM9DMCj9yzDE0Q7To=
golang.org/x/net v0.58.0/go.mod h1:YwCddHnFlT7eLQqVprV19OnhLGtc5xOKgE0RyqgfWAU=
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/text v0.41.0 h1:vz/seA0lnX87Othu2f/0L24RcgrXD9/YFTSuGjj3rH8=
golang.org/x/text v0.41.0/go.mod h1:jvf1O8ajNzZqhSrQBPbutR/EB83Cc0CFrezNQIwbb5M=
gonum.org/v1/gonum v0.17.0 h1:VbpOemQlsSMrYmn7T2OUvQ4dqxQXU+ouZFQsZOx50z4=
gonum.org/v1/gonum v0.17.0/go.mod h1:El3tOrEuMpv2UdMrbNlKEh9vd86bmQ6vqIcDwxEOc1E=
google.golang.org/genproto/googleapis/api v0.0.0-20260630182238-925bb5da69e7 h1:jQ9p21COKWjP3VwuFrNRiiOTMh3mPpN45R7SLrH/HUU=
google.golang.org/genproto/googleapis/api v0.0.0-20260630182238-925bb5da69e7/go.mod h1:KqHwBx2upmfa1XSi1WuRvC+2VGCLtooKkfmyvRbUmqA=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260630182238-925bb5da69e7 h1:eM/YSd5bBFagF51o1E745Ta7RwzpW0h+z+QDNZOgmQ8=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260630182238-925bb5da69e7/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/grpc v1.83.2 h1:EManeRomTObA0BU7I8vXgg/78uE5MJ9M8B39EX2WscU=
google.golang.org/grpc v1.83.2/go.mod h1:YPI1hK3kDked6iHvgX3tR0y+nX/qpMFKhPgFsokw1S8=
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=

package sample

import (
	"fmt"

	"cloud.google.com/go/kms/apiv1/kmspb"
)

// GetCryptoKeyVersionStateName returns the protobuf enum string name for the given state.
func GetCryptoKeyVersionStateName(state kmspb.CryptoKeyVersion_CryptoKeyVersionState) (string, bool) {
	name, ok := kmspb.CryptoKeyVersion_CryptoKeyVersionState_name[int32(state)]
	return name, ok
}

// GetCryptoKeyVersionStateValue returns the CryptoKeyVersion_CryptoKeyVersionState enum value for the given name.
func GetCryptoKeyVersionStateValue(name string) (kmspb.CryptoKeyVersion_CryptoKeyVersionState, bool) {
	val, ok := kmspb.CryptoKeyVersion_CryptoKeyVersionState_value[name]
	return kmspb.CryptoKeyVersion_CryptoKeyVersionState(val), ok
}

// DescribeCryptoKeyVersion returns a human-readable summary of a CryptoKeyVersion's resource name and resolved state.
func DescribeCryptoKeyVersion(version *kmspb.CryptoKeyVersion) string {
	if version == nil {
		return "nil version"
	}
	state := version.GetState()
	stateName, ok := kmspb.CryptoKeyVersion_CryptoKeyVersionState_name[int32(state)]
	if !ok {
		stateName = "UNKNOWN"
	}
	return fmt.Sprintf("%s (state: %s)", version.GetName(), stateName)
}

{
  "schemaVersion": 1,
  "goal": "verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name in pkg:golang/cloud.google.com/go/kms@v1.35.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/cloud.google.com/go/kms@v1.35.0"
  ],
  "symbols": [
    "cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion_CryptoKeyVersionState_name"
  ]
}

package main

import (
	"fmt"
	"os"

	"cloud.google.com/go/kms/apiv1/kmspb"
	"sample"
)

func main() {
	if err := runTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All CryptoKeyVersion_CryptoKeyVersionState contract tests passed successfully.")
}

func runTests() error {
	// 1. CryptoKeyVersion_CryptoKeyVersionState_name maps every defined CryptoKeyVersion_CryptoKeyVersionState enum constant to its protobuf string identifier.
	definedStates := []struct {
		state kmspb.CryptoKeyVersion_CryptoKeyVersionState
		name  string
	}{
		{kmspb.CryptoKeyVersion_CRYPTO_KEY_VERSION_STATE_UNSPECIFIED, "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED"},
		{kmspb.CryptoKeyVersion_PENDING_GENERATION, "PENDING_GENERATION"},
		{kmspb.CryptoKeyVersion_ENABLED, "ENABLED"},
		{kmspb.CryptoKeyVersion_DISABLED, "DISABLED"},
		{kmspb.CryptoKeyVersion_DESTROYED, "DESTROYED"},
		{kmspb.CryptoKeyVersion_DESTROY_SCHEDULED, "DESTROY_SCHEDULED"},
		{kmspb.CryptoKeyVersion_PENDING_IMPORT, "PENDING_IMPORT"},
		{kmspb.CryptoKeyVersion_IMPORT_FAILED, "IMPORT_FAILED"},
		{kmspb.CryptoKeyVersion_GENERATION_FAILED, "GENERATION_FAILED"},
		{kmspb.CryptoKeyVersion_PENDING_EXTERNAL_DESTRUCTION, "PENDING_EXTERNAL_DESTRUCTION"},
		{kmspb.CryptoKeyVersion_EXTERNAL_DESTRUCTION_FAILED, "EXTERNAL_DESTRUCTION_FAILED"},
	}

	for _, item := range definedStates {
		name, ok := kmspb.CryptoKeyVersion_CryptoKeyVersionState_name[int32(item.state)]
		if !ok {
			return fmt.Errorf("expected state %d to exist in CryptoKeyVersion_CryptoKeyVersionState_name", item.state)
		}
		if name != item.name {
			return fmt.Errorf("state %d mapped to %q, expected %q", item.state, name, item.name)
		}
		sampleName, sampleOk := sample.GetCryptoKeyVersionStateName(item.state)
		if !sampleOk || sampleName != item.name {
			return fmt.Errorf("sample helper failed for state %d: got (%q, %v), want (%q, true)", item.state, sampleName, sampleOk, item.name)
		}
	}

	// 2. CryptoKeyVersion_CryptoKeyVersionState_name returns the expected string name for ENABLED, DISABLED, DESTROYED, and PENDING_GENERATION states.
	keyStates := []struct {
		state        kmspb.CryptoKeyVersion_CryptoKeyVersionState
		expectedName string
	}{
		{kmspb.CryptoKeyVersion_ENABLED, "ENABLED"},
		{kmspb.CryptoKeyVersion_DISABLED, "DISABLED"},
		{kmspb.CryptoKeyVersion_DESTROYED, "DESTROYED"},
		{kmspb.CryptoKeyVersion_PENDING_GENERATION, "PENDING_GENERATION"},
	}
	for _, ks := range keyStates {
		n := kmspb.CryptoKeyVersion_CryptoKeyVersionState_name[int32(ks.state)]
		if n != ks.expectedName {
			return fmt.Errorf("expected state %d to be %q, got %q", ks.state, ks.expectedName, n)
		}
	}

	// 3. CryptoKeyVersion_CryptoKeyVersionState_value maps protobuf enum names back to their corresponding int32 values.
	for intVal, strName := range kmspb.CryptoKeyVersion_CryptoKeyVersionState_name {
		reverseVal, exists := kmspb.CryptoKeyVersion_CryptoKeyVersionState_value[strName]
		if !exists {
			return fmt.Errorf("name %q missing in CryptoKeyVersion_CryptoKeyVersionState_value", strName)
		}
		if reverseVal != intVal {
			return fmt.Errorf("reverse mapping mismatch for %q: got %d, want %d", strName, reverseVal, intVal)
		}
		sampleVal, sampleOk := sample.GetCryptoKeyVersionStateValue(strName)
		if !sampleOk || int32(sampleVal) != intVal {
			return fmt.Errorf("sample.GetCryptoKeyVersionStateValue failed for %q", strName)
		}
	}

	// 4. CryptoKeyVersion.GetState returns a CryptoKeyVersion_CryptoKeyVersionState that resolves in CryptoKeyVersion_CryptoKeyVersionState_name.
	msg := &kmspb.CryptoKeyVersion{
		Name:  "projects/example-project/locations/global/keyRings/ring/cryptoKeys/key/cryptoKeyVersions/1",
		State: kmspb.CryptoKeyVersion_ENABLED,
	}
	resolvedName, ok := kmspb.CryptoKeyVersion_CryptoKeyVersionState_name[int32(msg.GetState())]
	if !ok || resolvedName != "ENABLED" {
		return fmt.Errorf("failed to resolve message state: got (%q, %v), want (\"ENABLED\", true)", resolvedName, ok)
	}
	desc := sample.DescribeCryptoKeyVersion(msg)
	if desc != "projects/example-project/locations/global/keyRings/ring/cryptoKeys/key/cryptoKeyVersions/1 (state: ENABLED)" {
		return fmt.Errorf("unexpected describe output: %q", desc)
	}

	// 5. CryptoKeyVersion_CryptoKeyVersionState_name lookup with an undefined state returns empty string and false.
	invalidState := int32(99999)
	undefinedName, exists := kmspb.CryptoKeyVersion_CryptoKeyVersionState_name[invalidState]
	if exists || undefinedName != "" {
		return fmt.Errorf("expected undefined state lookup to fail, got name %q, exists=%v", undefinedName, exists)
	}
	sampleUndefName, sampleUndefOk := sample.GetCryptoKeyVersionStateName(kmspb.CryptoKeyVersion_CryptoKeyVersionState(invalidState))
	if sampleUndefOk || sampleUndefName != "" {
		return fmt.Errorf("expected sample helper undefined state lookup to fail, got (%q, %v)", sampleUndefName, sampleUndefOk)
	}

	return nil
}