Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo

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

Overview

TLS configuration information for VirtualHosts and TargetServers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1TlsInfo

Returns a new instance of GoogleCloudApigeeV1TlsInfo.


5244
5245
5246
# File 'generated/google/apis/apigee_v1/classes.rb', line 5244

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

Instance Attribute Details

#ciphersArray<String>

The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/ StandardNames.html#ciphersuites Corresponds to the JSON property ciphers

Returns:

  • (Array<String>)

5192
5193
5194
# File 'generated/google/apis/apigee_v1/classes.rb', line 5192

def ciphers
  @ciphers
end

#client_auth_enabledBoolean Also known as: client_auth_enabled?

Optional. Enables two-way TLS. Corresponds to the JSON property clientAuthEnabled

Returns:

  • (Boolean)

5197
5198
5199
# File 'generated/google/apis/apigee_v1/classes.rb', line 5197

def client_auth_enabled
  @client_auth_enabled
end

#common_nameGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfoCommonName

The TLS Common Name of the certificate. Corresponds to the JSON property commonName


5203
5204
5205
# File 'generated/google/apis/apigee_v1/classes.rb', line 5203

def common_name
  @common_name
end

#enabledBoolean Also known as: enabled?

Required. Enables one-way TLS. Corresponds to the JSON property enabled

Returns:

  • (Boolean)

5208
5209
5210
# File 'generated/google/apis/apigee_v1/classes.rb', line 5208

def enabled
  @enabled
end

#ignore_validation_errorsBoolean Also known as: ignore_validation_errors?

If true, Edge ignores TLS certificate errors. Valid when configuring TLS for target servers and target endpoints, and when configuring virtual hosts that use 2-way TLS. When used with a target endpoint/target server, if the backend system uses SNI and returns a cert with a subject Distinguished Name (DN) that does not match the hostname, there is no way to ignore the error and the connection fails. Corresponds to the JSON property ignoreValidationErrors

Returns:

  • (Boolean)

5219
5220
5221
# File 'generated/google/apis/apigee_v1/classes.rb', line 5219

def ignore_validation_errors
  @ignore_validation_errors
end

#key_aliasString

Required if client_auth_enabled is true. The resource ID for the alias containing the private key and cert. Corresponds to the JSON property keyAlias

Returns:

  • (String)

5226
5227
5228
# File 'generated/google/apis/apigee_v1/classes.rb', line 5226

def key_alias
  @key_alias
end

#key_storeString

Required if client_auth_enabled is true. The resource ID of the keystore. References not yet supported. Corresponds to the JSON property keyStore

Returns:

  • (String)

5232
5233
5234
# File 'generated/google/apis/apigee_v1/classes.rb', line 5232

def key_store
  @key_store
end

#protocolsArray<String>

The TLS versioins to be used. Corresponds to the JSON property protocols

Returns:

  • (Array<String>)

5237
5238
5239
# File 'generated/google/apis/apigee_v1/classes.rb', line 5237

def protocols
  @protocols
end

#trust_storeString

The resource ID of the truststore. References not yet supported. Corresponds to the JSON property trustStore

Returns:

  • (String)

5242
5243
5244
# File 'generated/google/apis/apigee_v1/classes.rb', line 5242

def trust_store
  @trust_store
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
# File 'generated/google/apis/apigee_v1/classes.rb', line 5249

def update!(**args)
  @ciphers = args[:ciphers] if args.key?(:ciphers)
  @client_auth_enabled = args[:client_auth_enabled] if args.key?(:client_auth_enabled)
  @common_name = args[:common_name] if args.key?(:common_name)
  @enabled = args[:enabled] if args.key?(:enabled)
  @ignore_validation_errors = args[:ignore_validation_errors] if args.key?(:ignore_validation_errors)
  @key_alias = args[:key_alias] if args.key?(:key_alias)
  @key_store = args[:key_store] if args.key?(:key_store)
  @protocols = args[:protocols] if args.key?(:protocols)
  @trust_store = args[:trust_store] if args.key?(:trust_store)
end