target.apidocs.com.google.api.services.compute.model.ClientTlsSettings.html Maven / Gradle / Ivy

Go to download







ClientTlsSettings (Compute Engine API alpha-rev20200526-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class ClientTlsSettings



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.ClientTlsSettings













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class ClientTlsSettings
extends GenericJson
[Deprecated] The client side authentication settings for connection originating from the backend
 service. the backend service.

  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 Compute Engine 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
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


ClientTlsSettings() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ClientTlsSettings
clone() 


TlsContext
getClientTlsContext()
Configures the mechanism to obtain client-side security certificates and identity information.



String
getMode()
Indicates whether connections to this port should be secured using TLS.



String
getSni()
SNI string to present to the server during TLS handshake.



List<String>
getSubjectAltNames()
A list of alternate names to verify the subject identity in the certificate.If specified, the
 proxy will verify that the server certificate's subject alt name matches one of the specified
 values.



ClientTlsSettings
set(String fieldName,
   Object value) 


ClientTlsSettings
setClientTlsContext(TlsContext clientTlsContext)
Configures the mechanism to obtain client-side security certificates and identity information.



ClientTlsSettings
setMode(String mode)
Indicates whether connections to this port should be secured using TLS.



ClientTlsSettings
setSni(String sni)
SNI string to present to the server during TLS handshake.



ClientTlsSettings
setSubjectAltNames(List<String> subjectAltNames)
A list of alternate names to verify the subject identity in the certificate.If specified, the
 proxy will verify that the server certificate's subject alt name matches one of the specified
 values.







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





ClientTlsSettings
public ClientTlsSettings()









Method Detail





getClientTlsContext
public TlsContext getClientTlsContext()
Configures the mechanism to obtain client-side security certificates and identity information.
 This field is only applicable when mode is set to MUTUAL.

Returns:
value or null for none








setClientTlsContext
public ClientTlsSettings setClientTlsContext(TlsContext clientTlsContext)
Configures the mechanism to obtain client-side security certificates and identity information.
 This field is only applicable when mode is set to MUTUAL.

Parameters:
clientTlsContext - clientTlsContext or null for none








getMode
public String getMode()
Indicates whether connections to this port should be secured using TLS. The value of this field
 determines how TLS is enforced. This can be set to one of the following values: DISABLE: Do not
 setup a TLS connection to the backends. SIMPLE: Originate a TLS connection to the backends.
 MUTUAL: Secure connections to the backends using mutual TLS by presenting client certificates
 for authentication.

Returns:
value or null for none








setMode
public ClientTlsSettings setMode(String mode)
Indicates whether connections to this port should be secured using TLS. The value of this field
 determines how TLS is enforced. This can be set to one of the following values: DISABLE: Do not
 setup a TLS connection to the backends. SIMPLE: Originate a TLS connection to the backends.
 MUTUAL: Secure connections to the backends using mutual TLS by presenting client certificates
 for authentication.

Parameters:
mode - mode or null for none








getSni
public String getSni()
SNI string to present to the server during TLS handshake. This field is applicable only when
 mode is SIMPLE or MUTUAL.

Returns:
value or null for none








setSni
public ClientTlsSettings setSni(String sni)
SNI string to present to the server during TLS handshake. This field is applicable only when
 mode is SIMPLE or MUTUAL.

Parameters:
sni - sni or null for none








getSubjectAltNames
public List<String> getSubjectAltNames()
A list of alternate names to verify the subject identity in the certificate.If specified, the
 proxy will verify that the server certificate's subject alt name matches one of the specified
 values. This field is applicable only when mode is SIMPLE or MUTUAL.

Returns:
value or null for none








setSubjectAltNames
public ClientTlsSettings setSubjectAltNames(List<String> subjectAltNames)
A list of alternate names to verify the subject identity in the certificate.If specified, the
 proxy will verify that the server certificate's subject alt name matches one of the specified
 values. This field is applicable only when mode is SIMPLE or MUTUAL.

Parameters:
subjectAltNames - subjectAltNames or null for none








set
public ClientTlsSettings set(String fieldName,
                             Object value)

Overrides:
set in class GenericJson








clone
public ClientTlsSettings clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`ClientTlsSettings`	`clone()`
`TlsContext`	`getClientTlsContext()` Configures the mechanism to obtain client-side security certificates and identity information.
`String`	`getMode()` Indicates whether connections to this port should be secured using TLS.
`String`	`getSni()` SNI string to present to the server during TLS handshake.
`List<String>`	`getSubjectAltNames()` A list of alternate names to verify the subject identity in the certificate.If specified, the proxy will verify that the server certificate's subject alt name matches one of the specified values.
`ClientTlsSettings`	`set(String fieldName, Object value)`
`ClientTlsSettings`	`setClientTlsContext(TlsContext clientTlsContext)` Configures the mechanism to obtain client-side security certificates and identity information.
`ClientTlsSettings`	`setMode(String mode)` Indicates whether connections to this port should be secured using TLS.
`ClientTlsSettings`	`setSni(String sni)` SNI string to present to the server during TLS handshake.
`ClientTlsSettings`	`setSubjectAltNames(List<String> subjectAltNames)` A list of alternate names to verify the subject identity in the certificate.If specified, the proxy will verify that the server certificate's subject alt name matches one of the specified values.