Package com.google.genai.types

Class EncryptionSpec

  • All Implemented Interfaces:
    
public abstract class EncryptionSpec
extends JsonSerializable

    Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. This data type is not supported in Gemini API.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public abstract class EncryptionSpec.Builder

      Builder for EncryptionSpec.

    • Constructor Summary

      Constructors 
      Constructor Description
      EncryptionSpec()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Optional<String> kmsKeyName() Required.
      static EncryptionSpec.Builder builder() Instantiates a builder for EncryptionSpec.
      abstract EncryptionSpec.Builder toBuilder() Creates a builder with the same values as this instance.
      static EncryptionSpec fromJson(String jsonString) Deserializes a JSON string to a EncryptionSpec object.

      • Methods inherited from class com.google.genai.JsonSerializable

        fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • EncryptionSpec

        EncryptionSpec()

    • Method Detail

      • kmsKeyName

         abstract Optional<String> kmsKeyName()

        Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.