final case class Gcp(locationId: String, projectId: String, keyRingId: String, auditLogging: Boolean = false, retries: RetryConfig = RetryConfig(), endpointOverride: Option[String] = None) extends KmsConfig with EnterpriseOnlyCantonConfigValidation with Product with Serializable
Stores the configuration for GCP KMS. This configuration is mandatory if we want to protect Canton's private keys using a GCP KMS.
- locationId
defines the GCP region to use (e.g. us-east1)
- projectId
defines a GCP project to use (e.g. gcp-kms-testing)
- keyRingId
defines a key-ring to where keys will be added. This can be created as a multi-region key-ring, which enables multi-region keys
- auditLogging
when enabled, all calls to KMS will be logged. Defaults to false.
- retries
retry configuration
- endpointOverride
the [optional] endpoint for a proxy to be used by the KMS client.
- Alphabetic
- By Inheritance
- Gcp
- Serializable
- Product
- Equals
- EnterpriseOnlyCantonConfigValidation
- PredicatedCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- KmsConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Gcp(locationId: String, projectId: String, keyRingId: String, auditLogging: Boolean = false, retries: RetryConfig = RetryConfig(), endpointOverride: Option[String] = None)
- locationId
defines the GCP region to use (e.g. us-east1)
- projectId
defines a GCP project to use (e.g. gcp-kms-testing)
- keyRingId
defines a key-ring to where keys will be added. This can be created as a multi-region key-ring, which enables multi-region keys
- auditLogging
when enabled, all calls to KMS will be logged. Defaults to false.
- retries
retry configuration
- endpointOverride
the [optional] endpoint for a proxy to be used by the KMS client.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def allowThisInCommunity: Boolean
- Attributes
- protected
- Definition Classes
- EnterpriseOnlyCantonConfigValidation → PredicatedCantonConfigValidation
- def allowThisInEnterprise: Boolean
- Attributes
- protected
- Definition Classes
- PredicatedCantonConfigValidation
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val auditLogging: Boolean
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]
Returns all validation errors that are specific to this Canton configuration class.
Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.
Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.
- Attributes
- protected
- Definition Classes
- PredicatedCantonConfigValidation → CustomCantonConfigValidation
- val endpointOverride: Option[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val keyRingId: String
- val locationId: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val projectId: String
- val retries: RetryConfig
Retry configuration for KMS operations
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def validate[T >: Gcp.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
- Definition Classes
- CantonConfigValidation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])