Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TraceConfigOtelMtlsConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Overview

OtelMtlsConfig configures mutual TLS for the outbound OTel Collector connection by referencing already-uploaded Keystore/Truststore aliases. Key/ cert material is uploaded via the existing Keystore Alias APIs (POST .../ keystores/ks/aliases), the same APIs used to configure mTLS for TargetServer.tls_info. Only the resource IDs of those aliases live in this message; no secret material is inlined into TraceConfig. Field shape mirrors TlsInfo used by TargetServer.tls_info: - key_store and trust_store accept either a plain keystore ID or a ref://referenceID`URI (an environment-scoped Reference whoseresource_typeisKeyStore/TrustStore). References enable rotation without editing the TraceConfig itself. - key_aliasis the plain alias ID withinkey_store. Fields that would normally appear onTlsInfo` (enabled, client_auth_enabled, protocols, enforce, ignore_validation_errors) are intentionally omitted from this customer surface. The runtime enforces secure defaults: - Mutual TLS is always required (both server AND client cert exchanged). - Server certificate validation is always strict (no ignoring errors). - TLS 1.2 and TLS 1.3 are enabled; older versions are rejected.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1TraceConfigOtelMtlsConfig

Returns a new instance of GoogleCloudApigeeV1TraceConfigOtelMtlsConfig.



13353
13354
13355
# File 'lib/google/apis/apigee_v1/classes.rb', line 13353

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#key_aliasString

Required. Plain alias ID within key_store that contains the client key/cert used for mTLS. Corresponds to the JSON property keyAlias

Returns:

  • (String)


13333
13334
13335
# File 'lib/google/apis/apigee_v1/classes.rb', line 13333

def key_alias
  @key_alias
end

#key_storeString

Required. Keystore holding the client-side key/cert alias. Accepts either a plain keystore ID (e.g. my-keystore) resolving to organizations/org/ environments/env/keystores/key_store, or a reference URI of the form `ref: //`referenceID that points to a Reference whose resource_type is KeyStore . Corresponds to the JSON property keyStore

Returns:

  • (String)


13342
13343
13344
# File 'lib/google/apis/apigee_v1/classes.rb', line 13342

def key_store
  @key_store
end

#trust_storeString

Required. Truststore holding the CA(s) that signed the OTel Collector's server certificate. Accepts either a plain keystore ID (e.g. my-truststore) resolving to organizations/org/environments/env/keystores/trust_store, or a reference URI of the form `ref://`referenceID that points to a Reference whose resource_type is KeyStore (used as a truststore). Corresponds to the JSON property trustStore

Returns:

  • (String)


13351
13352
13353
# File 'lib/google/apis/apigee_v1/classes.rb', line 13351

def trust_store
  @trust_store
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13358
13359
13360
13361
13362
# File 'lib/google/apis/apigee_v1/classes.rb', line 13358

def update!(**args)
  @key_alias = args[:key_alias] if args.key?(:key_alias)
  @key_store = args[:key_store] if args.key?(:key_store)
  @trust_store = args[:trust_store] if args.key?(:trust_store)
end