GoogleCloudApigeeV1TlsInfo (Apigee API v1-rev20251125-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1TlsInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1TlsInfo
extends com.google.api.client.json.GenericJson
```
TLS configuration information for virtual hosts and TargetServers.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudApigeeV1TlsInfo()

Constructors
Constructor and Description
`GoogleCloudApigeeV1TlsInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1TlsInfo`	`clone()`
`List<String>`	`getCiphers()` The SSL/TLS cipher suites to be used.
`Boolean`	`getClientAuthEnabled()` Optional.
`GoogleCloudApigeeV1TlsInfoCommonName`	`getCommonName()` The TLS Common Name of the certificate.
`Boolean`	`getEnabled()` Required.
`Boolean`	`getEnforce()` TLS is strictly enforced.
`Boolean`	`getIgnoreValidationErrors()` If true, Edge ignores TLS certificate errors.
`String`	`getKeyAlias()` Required if `client_auth_enabled` is true.
`String`	`getKeyStore()` Required if `client_auth_enabled` is true.
`List<String>`	`getProtocols()` The TLS versioins to be used.
`String`	`getTrustStore()` The resource ID of the truststore.
`GoogleCloudApigeeV1TlsInfo`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1TlsInfo`	`setCiphers(List<String> ciphers)` The SSL/TLS cipher suites to be used.
`GoogleCloudApigeeV1TlsInfo`	`setClientAuthEnabled(Boolean clientAuthEnabled)` Optional.
`GoogleCloudApigeeV1TlsInfo`	`setCommonName(GoogleCloudApigeeV1TlsInfoCommonName commonName)` The TLS Common Name of the certificate.
`GoogleCloudApigeeV1TlsInfo`	`setEnabled(Boolean enabled)` Required.
`GoogleCloudApigeeV1TlsInfo`	`setEnforce(Boolean enforce)` TLS is strictly enforced.
`GoogleCloudApigeeV1TlsInfo`	`setIgnoreValidationErrors(Boolean ignoreValidationErrors)` If true, Edge ignores TLS certificate errors.
`GoogleCloudApigeeV1TlsInfo`	`setKeyAlias(String keyAlias)` Required if `client_auth_enabled` is true.
`GoogleCloudApigeeV1TlsInfo`	`setKeyStore(String keyStore)` Required if `client_auth_enabled` is true.
`GoogleCloudApigeeV1TlsInfo`	`setProtocols(List<String> protocols)` The TLS versioins to be used.
`GoogleCloudApigeeV1TlsInfo`	`setTrustStore(String trustStore)` The resource ID of the truststore.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudApigeeV1TlsInfo
```
public GoogleCloudApigeeV1TlsInfo()
```
- Method Detail
  - getCiphers
```
public List<String> getCiphers()
```
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite- configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    
    Returns:
    
    value or null for none
  - setCiphers
```
public GoogleCloudApigeeV1TlsInfo setCiphers(List<String> ciphers)
```
    The SSL/TLS cipher suites to be used. For programmable proxies, it must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites. For configurable proxies, it must follow the configuration specified in: https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#Cipher-suite- configuration. This setting has no effect for configurable proxies when negotiating TLS 1.3.
    
    Parameters:
    
    ciphers - ciphers or null for none
  - getClientAuthEnabled
```
public Boolean getClientAuthEnabled()
```
    Optional. Enables two-way TLS.
    
    Returns:
    
    value or null for none
  - setClientAuthEnabled
```
public GoogleCloudApigeeV1TlsInfo setClientAuthEnabled(Boolean clientAuthEnabled)
```
    Optional. Enables two-way TLS.
    
    Parameters:
    
    clientAuthEnabled - clientAuthEnabled or null for none
  - getCommonName
```
public GoogleCloudApigeeV1TlsInfoCommonName getCommonName()
```
    The TLS Common Name of the certificate.
    
    Returns:
    
    value or null for none
  - setCommonName
```
public GoogleCloudApigeeV1TlsInfo setCommonName(GoogleCloudApigeeV1TlsInfoCommonName commonName)
```
    The TLS Common Name of the certificate.
    
    Parameters:
    
    commonName - commonName or null for none
  - getEnabled
```
public Boolean getEnabled()
```
    Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    
    Returns:
    
    value or null for none
  - setEnabled
```
public GoogleCloudApigeeV1TlsInfo setEnabled(Boolean enabled)
```
    Required. Enables TLS. If false, neither one-way nor two-way TLS will be enabled.
    
    Parameters:
    
    enabled - enabled or null for none
  - getEnforce
```
public Boolean getEnforce()
```
    TLS is strictly enforced.
    
    Returns:
    
    value or null for none
  - setEnforce
```
public GoogleCloudApigeeV1TlsInfo setEnforce(Boolean enforce)
```
    TLS is strictly enforced.
    
    Parameters:
    
    enforce - enforce or null for none
  - getIgnoreValidationErrors
```
public Boolean getIgnoreValidationErrors()
```
    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.
    
    Returns:
    
    value or null for none
  - setIgnoreValidationErrors
```
public GoogleCloudApigeeV1TlsInfo setIgnoreValidationErrors(Boolean ignoreValidationErrors)
```
    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.
    
    Parameters:
    
    ignoreValidationErrors - ignoreValidationErrors or null for none
  - getKeyAlias
```
public String getKeyAlias()
```
    Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
    
    Returns:
    
    value or null for none
  - setKeyAlias
```
public GoogleCloudApigeeV1TlsInfo setKeyAlias(String keyAlias)
```
    Required if `client_auth_enabled` is true. The resource ID for the alias containing the private key and cert.
    
    Parameters:
    
    keyAlias - keyAlias or null for none
  - getKeyStore
```
public String getKeyStore()
```
    Required if `client_auth_enabled` is true. The resource ID of the keystore.
    
    Returns:
    
    value or null for none
  - setKeyStore
```
public GoogleCloudApigeeV1TlsInfo setKeyStore(String keyStore)
```
    Required if `client_auth_enabled` is true. The resource ID of the keystore.
    
    Parameters:
    
    keyStore - keyStore or null for none
  - getProtocols
```
public List<String> getProtocols()
```
    The TLS versioins to be used.
    
    Returns:
    
    value or null for none
  - setProtocols
```
public GoogleCloudApigeeV1TlsInfo setProtocols(List<String> protocols)
```
    The TLS versioins to be used.
    
    Parameters:
    
    protocols - protocols or null for none
  - getTrustStore
```
public String getTrustStore()
```
    The resource ID of the truststore.
    
    Returns:
    
    value or null for none
  - setTrustStore
```
public GoogleCloudApigeeV1TlsInfo setTrustStore(String trustStore)
```
    The resource ID of the truststore.
    
    Parameters:
    
    trustStore - trustStore or null for none
  - set
```
public GoogleCloudApigeeV1TlsInfo set(String fieldName,
                                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1TlsInfo clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1TlsInfo

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudApigeeV1TlsInfo

Method Detail

getCiphers

setCiphers

getClientAuthEnabled

setClientAuthEnabled

getCommonName

setCommonName

getEnabled

setEnabled

getEnforce

setEnforce

getIgnoreValidationErrors

setIgnoreValidationErrors

getKeyAlias

setKeyAlias

getKeyStore

setKeyStore

getProtocols

setProtocols

getTrustStore

setTrustStore

set

clone