http4s-grpc-google-cloud-kms-v1
0.127.0+0.0.6
API
Generated with
http4s-grpc-google-cloud-kms-v1/com.google.cloud.kms.v1/com.google.cloud.kms.v1.ekm_service

com.google.cloud.kms.v1.ekm_service

package com.google.cloud.kms.v1.ekm_service

Members list

Type members

Classlikes

final case class Certificate(rawDer: ByteString, parsed: Boolean, issuer: String, subject: String, subjectAlternativeDnsNames: Seq[String], notBeforeTime: Option[Timestamp], notAfterTime: Option[Timestamp], serialNumber: String, sha256Fingerprint: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Certificate]

A [Certificate][google.cloud.kms.v1.Certificate] represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.

A [Certificate][google.cloud.kms.v1.Certificate] represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.

Value parameters

issuer

Output only. The issuer distinguished name in RFC 2253 format. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

notAfterTime

Output only. The certificate is not valid after this time. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

notBeforeTime

Output only. The certificate is not valid before this time. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

parsed

Output only. True if the certificate was parsed successfully.

rawDer

Required. The raw certificate bytes in DER format.

serialNumber

Output only. The certificate serial number as a hex string. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

sha256Fingerprint

Output only. The SHA-256 certificate fingerprint as a hex string. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

subject

Output only. The subject distinguished name in RFC 2253 format. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

subjectAlternativeDnsNames

Output only. The subject Alternative DNS names. Only present if [parsed][google.cloud.kms.v1.Certificate.parsed] is true.

Attributes

Companion
object
Source
Certificate.scala
Supertypes
trait Updatable[Certificate]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Certificate extends GeneratedMessageCompanion[Certificate]

Attributes

Companion
class
Source
Certificate.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Certificate]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CreateEkmConnectionRequest(parent: String, ekmConnectionId: String, ekmConnection: Option[EkmConnection], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateEkmConnectionRequest]

Request message for [EkmService.CreateEkmConnection][google.cloud.kms.v1.EkmService.CreateEkmConnection].

Request message for [EkmService.CreateEkmConnection][google.cloud.kms.v1.EkmService.CreateEkmConnection].

Value parameters

ekmConnection

Required. An [EkmConnection][google.cloud.kms.v1.EkmConnection] with initial field values.

ekmConnectionId

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

parent

Required. The resource name of the location associated with the [EkmConnection][google.cloud.kms.v1.EkmConnection], in the format projects/*/locations/*.

Attributes

Companion
object
Source
CreateEkmConnectionRequest.scala
Supertypes
trait Updatable[CreateEkmConnectionRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateEkmConnectionRequest extends GeneratedMessageCompanion[CreateEkmConnectionRequest]

Attributes

Companion
class
Source
CreateEkmConnectionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateEkmConnectionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class EkmConfig(name: String, defaultEkmConnection: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[EkmConfig]

An [EkmConfig][google.cloud.kms.v1.EkmConfig] is a singleton resource that represents configuration parameters that apply to all [CryptoKeys][google.cloud.kms.v1.CryptoKey] and [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a given project and location.

An [EkmConfig][google.cloud.kms.v1.EkmConfig] is a singleton resource that represents configuration parameters that apply to all [CryptoKeys][google.cloud.kms.v1.CryptoKey] and [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a given project and location.

Value parameters

defaultEkmConnection

Optional. Resource name of the default [EkmConnection][google.cloud.kms.v1.EkmConnection]. Setting this field to the empty string removes the default.

name

Output only. The resource name for the [EkmConfig][google.cloud.kms.v1.EkmConfig] in the format projects/*/locations/*/ekmConfig.

Attributes

Companion
object
Source
EkmConfig.scala
Supertypes
trait Updatable[EkmConfig]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EkmConfig extends GeneratedMessageCompanion[EkmConfig]

Attributes

Companion
class
Source
EkmConfig.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[EkmConfig]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
EkmConfig.type
final case class EkmConnection(name: String, createTime: Option[Timestamp], serviceResolvers: Seq[ServiceResolver], etag: String, keyManagementMode: KeyManagementMode, cryptoSpacePath: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[EkmConnection]

An [EkmConnection][google.cloud.kms.v1.EkmConnection] represents an individual EKM connection.

An [EkmConnection][google.cloud.kms.v1.EkmConnection] represents an individual EKM connection. It can be used for creating [CryptoKeys][google.cloud.kms.v1.CryptoKey] and [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as well as performing cryptographic operations using keys created within the [EkmConnection][google.cloud.kms.v1.EkmConnection].

Value parameters

createTime

Output only. The time at which the [EkmConnection][google.cloud.kms.v1.EkmConnection] was created.

cryptoSpacePath

Optional. Identifies the EKM Crypto Space that this [EkmConnection][google.cloud.kms.v1.EkmConnection] maps to. Note: This field is required if [KeyManagementMode][google.cloud.kms.v1.EkmConnection.KeyManagementMode] is [CLOUD_KMS][google.cloud.kms.v1.EkmConnection.KeyManagementMode.CLOUD_KMS].

etag

Optional. Etag of the currently stored [EkmConnection][google.cloud.kms.v1.EkmConnection].

keyManagementMode

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to [MANUAL][google.cloud.kms.v1.EkmConnection.KeyManagementMode.MANUAL].

name

Output only. The resource name for the [EkmConnection][google.cloud.kms.v1.EkmConnection] in the format projects/*/locations/*/ekmConnections/*.

serviceResolvers

A list of [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is supported.

Attributes

Companion
object
Source
EkmConnection.scala
Supertypes
trait Updatable[EkmConnection]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EkmConnection extends GeneratedMessageCompanion[EkmConnection]

Attributes

Companion
class
Source
EkmConnection.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[EkmConnection]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
trait EkmService[F[_]]

Google Cloud Key Management EKM Service

Google Cloud Key Management EKM Service

Manages external cryptographic keys and operations using those keys. Implements a REST model with the following objects: * [EkmConnection][google.cloud.kms.v1.EkmConnection]

Attributes

Companion
object
Source
EkmService.scala
Supertypes
class Object
trait Matchable
class Any
object EkmService

Attributes

Companion
trait
Source
EkmService.scala
Supertypes
class Object
trait Matchable
class Any
Self type
EkmService.type
object EkmServiceProto extends GeneratedFileObject

Attributes

Source
EkmServiceProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class GetEkmConfigRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetEkmConfigRequest]

Request message for [EkmService.GetEkmConfig][google.cloud.kms.v1.EkmService.GetEkmConfig].

Request message for [EkmService.GetEkmConfig][google.cloud.kms.v1.EkmService.GetEkmConfig].

Value parameters

name

Required. The [name][google.cloud.kms.v1.EkmConfig.name] of the [EkmConfig][google.cloud.kms.v1.EkmConfig] to get.

Attributes

Companion
object
Source
GetEkmConfigRequest.scala
Supertypes
trait Updatable[GetEkmConfigRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetEkmConfigRequest extends GeneratedMessageCompanion[GetEkmConfigRequest]

Attributes

Companion
class
Source
GetEkmConfigRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetEkmConfigRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetEkmConnectionRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetEkmConnectionRequest]

Request message for [EkmService.GetEkmConnection][google.cloud.kms.v1.EkmService.GetEkmConnection].

Request message for [EkmService.GetEkmConnection][google.cloud.kms.v1.EkmService.GetEkmConnection].

Value parameters

name

Required. The [name][google.cloud.kms.v1.EkmConnection.name] of the [EkmConnection][google.cloud.kms.v1.EkmConnection] to get.

Attributes

Companion
object
Source
GetEkmConnectionRequest.scala
Supertypes
trait Updatable[GetEkmConnectionRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetEkmConnectionRequest extends GeneratedMessageCompanion[GetEkmConnectionRequest]

Attributes

Companion
class
Source
GetEkmConnectionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetEkmConnectionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListEkmConnectionsRequest(parent: String, pageSize: Int, pageToken: String, filter: String, orderBy: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListEkmConnectionsRequest]

Request message for [EkmService.ListEkmConnections][google.cloud.kms.v1.EkmService.ListEkmConnections].

Request message for [EkmService.ListEkmConnections][google.cloud.kms.v1.EkmService.ListEkmConnections].

Value parameters

filter

Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).

orderBy

Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).

pageSize

Optional. Optional limit on the number of [EkmConnections][google.cloud.kms.v1.EkmConnection] to include in the response. Further [EkmConnections][google.cloud.kms.v1.EkmConnection] can subsequently be obtained by including the [ListEkmConnectionsResponse.next_page_token][google.cloud.kms.v1.ListEkmConnectionsResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.

pageToken

Optional. Optional pagination token, returned earlier via [ListEkmConnectionsResponse.next_page_token][google.cloud.kms.v1.ListEkmConnectionsResponse.next_page_token].

parent

Required. The resource name of the location associated with the [EkmConnections][google.cloud.kms.v1.EkmConnection] to list, in the format projects/*/locations/*.

Attributes

Companion
object
Source
ListEkmConnectionsRequest.scala
Supertypes
trait Updatable[ListEkmConnectionsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListEkmConnectionsRequest extends GeneratedMessageCompanion[ListEkmConnectionsRequest]

Attributes

Companion
class
Source
ListEkmConnectionsRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListEkmConnectionsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ListEkmConnectionsResponse(ekmConnections: Seq[EkmConnection], nextPageToken: String, totalSize: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ListEkmConnectionsResponse]

Response message for [EkmService.ListEkmConnections][google.cloud.kms.v1.EkmService.ListEkmConnections].

Response message for [EkmService.ListEkmConnections][google.cloud.kms.v1.EkmService.ListEkmConnections].

Value parameters

ekmConnections

The list of [EkmConnections][google.cloud.kms.v1.EkmConnection].

nextPageToken

A token to retrieve next page of results. Pass this value in [ListEkmConnectionsRequest.page_token][google.cloud.kms.v1.ListEkmConnectionsRequest.page_token] to retrieve the next page of results.

totalSize

The total number of [EkmConnections][google.cloud.kms.v1.EkmConnection] that matched the query.

Attributes

Companion
object
Source
ListEkmConnectionsResponse.scala
Supertypes
trait Updatable[ListEkmConnectionsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ListEkmConnectionsResponse extends GeneratedMessageCompanion[ListEkmConnectionsResponse]

Attributes

Companion
class
Source
ListEkmConnectionsResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ListEkmConnectionsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateEkmConfigRequest(ekmConfig: Option[EkmConfig], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateEkmConfigRequest]

Request message for [EkmService.UpdateEkmConfig][google.cloud.kms.v1.EkmService.UpdateEkmConfig].

Request message for [EkmService.UpdateEkmConfig][google.cloud.kms.v1.EkmService.UpdateEkmConfig].

Value parameters

ekmConfig

Required. [EkmConfig][google.cloud.kms.v1.EkmConfig] with updated values.

updateMask

Required. List of fields to be updated in this request.

Attributes

Companion
object
Source
UpdateEkmConfigRequest.scala
Supertypes
trait Updatable[UpdateEkmConfigRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateEkmConfigRequest extends GeneratedMessageCompanion[UpdateEkmConfigRequest]

Attributes

Companion
class
Source
UpdateEkmConfigRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateEkmConfigRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateEkmConnectionRequest(ekmConnection: Option[EkmConnection], updateMask: Option[FieldMask], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateEkmConnectionRequest]

Request message for [EkmService.UpdateEkmConnection][google.cloud.kms.v1.EkmService.UpdateEkmConnection].

Request message for [EkmService.UpdateEkmConnection][google.cloud.kms.v1.EkmService.UpdateEkmConnection].

Value parameters

ekmConnection

Required. [EkmConnection][google.cloud.kms.v1.EkmConnection] with updated values.

updateMask

Required. List of fields to be updated in this request.

Attributes

Companion
object
Source
UpdateEkmConnectionRequest.scala
Supertypes
trait Updatable[UpdateEkmConnectionRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateEkmConnectionRequest extends GeneratedMessageCompanion[UpdateEkmConnectionRequest]

Attributes

Companion
class
Source
UpdateEkmConnectionRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateEkmConnectionRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class VerifyConnectivityRequest(name: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[VerifyConnectivityRequest]

Request message for [EkmService.VerifyConnectivity][google.cloud.kms.v1.EkmService.VerifyConnectivity].

Request message for [EkmService.VerifyConnectivity][google.cloud.kms.v1.EkmService.VerifyConnectivity].

Value parameters

name

Required. The [name][google.cloud.kms.v1.EkmConnection.name] of the [EkmConnection][google.cloud.kms.v1.EkmConnection] to verify.

Attributes

Companion
object
Source
VerifyConnectivityRequest.scala
Supertypes
trait Updatable[VerifyConnectivityRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VerifyConnectivityRequest extends GeneratedMessageCompanion[VerifyConnectivityRequest]

Attributes

Companion
class
Source
VerifyConnectivityRequest.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[VerifyConnectivityRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class VerifyConnectivityResponse(unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[VerifyConnectivityResponse]

Response message for [EkmService.VerifyConnectivity][google.cloud.kms.v1.EkmService.VerifyConnectivity].

Response message for [EkmService.VerifyConnectivity][google.cloud.kms.v1.EkmService.VerifyConnectivity].

Attributes

Companion
object
Source
VerifyConnectivityResponse.scala
Supertypes
trait Updatable[VerifyConnectivityResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VerifyConnectivityResponse extends GeneratedMessageCompanion[VerifyConnectivityResponse]

Attributes

Companion
class
Source
VerifyConnectivityResponse.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[VerifyConnectivityResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with