com.google.api.services.compute.model

Class SecuritySettings

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.SecuritySettings

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SecuritySettings
extends com.google.api.client.json.GenericJson

The authentication and authorization settings for a BackendService.

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

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
SecuritySettings()

Method Summary

Modifier and Type	Method and Description
SecuritySettings	clone()
String	getAuthentication() [Deprecated] Use clientTlsPolicy instead.
AuthenticationPolicy	getAuthenticationPolicy() [Deprecated] Authentication policy defines what authentication methods can be accepted on backends, and if authenticated, which method/certificate will set the request principal.
AuthorizationConfig	getAuthorizationConfig() [Deprecated] Authorization config defines the Role Based Access Control (RBAC) config.
AWSV4Signature	getAwsV4Authentication() The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication.
String	getClientTlsPolicy() Optional.
ClientTlsSettings	getClientTlsSettings() [Deprecated] TLS Settings for the backend service.
List<String>	getSubjectAltNames() Optional.
SecuritySettings	set(String fieldName, Object value)
SecuritySettings	setAuthentication(String authentication) [Deprecated] Use clientTlsPolicy instead.
SecuritySettings	setAuthenticationPolicy(AuthenticationPolicy authenticationPolicy) [Deprecated] Authentication policy defines what authentication methods can be accepted on backends, and if authenticated, which method/certificate will set the request principal.
SecuritySettings	setAuthorizationConfig(AuthorizationConfig authorizationConfig) [Deprecated] Authorization config defines the Role Based Access Control (RBAC) config.
SecuritySettings	setAwsV4Authentication(AWSV4Signature awsV4Authentication) The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication.
SecuritySettings	setClientTlsPolicy(String clientTlsPolicy) Optional.
SecuritySettings	setClientTlsSettings(ClientTlsSettings clientTlsSettings) [Deprecated] TLS Settings for the backend service.
SecuritySettings	setSubjectAltNames(List<String> subjectAltNames) Optional.

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

SecuritySettings

public SecuritySettings()

Method Detail

getAuthentication

public String getAuthentication()

[Deprecated] Use clientTlsPolicy instead.

Returns:

value or null for none

setAuthentication

public SecuritySettings setAuthentication(String authentication)

[Deprecated] Use clientTlsPolicy instead.

Parameters:

authentication - authentication or null for none

getAuthenticationPolicy

public AuthenticationPolicy getAuthenticationPolicy()

[Deprecated] Authentication policy defines what authentication methods can be accepted on backends, and if authenticated, which method/certificate will set the request principal. request principal.

Returns:

value or null for none

setAuthenticationPolicy

public SecuritySettings setAuthenticationPolicy(AuthenticationPolicy authenticationPolicy)

[Deprecated] Authentication policy defines what authentication methods can be accepted on backends, and if authenticated, which method/certificate will set the request principal. request principal.

Parameters:

authenticationPolicy - authenticationPolicy or null for none

getAuthorizationConfig

public AuthorizationConfig getAuthorizationConfig()

[Deprecated] Authorization config defines the Role Based Access Control (RBAC) config. Authorization config defines the Role Based Access Control (RBAC) config.

Returns:

value or null for none

setAuthorizationConfig

public SecuritySettings setAuthorizationConfig(AuthorizationConfig authorizationConfig)

[Deprecated] Authorization config defines the Role Based Access Control (RBAC) config. Authorization config defines the Role Based Access Control (RBAC) config.

Parameters:

authorizationConfig - authorizationConfig or null for none

getAwsV4Authentication

public AWSV4Signature getAwsV4Authentication()

The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

Returns:

value or null for none

setAwsV4Authentication

public SecuritySettings setAwsV4Authentication(AWSV4Signature awsV4Authentication)

The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.

Parameters:

awsV4Authentication - awsV4Authentication or null for none

getClientTlsPolicy

public String getClientTlsPolicy()

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.

Returns:

value or null for none

setClientTlsPolicy

public SecuritySettings setClientTlsPolicy(String clientTlsPolicy)

Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted. Note: This field currently has no impact.

Parameters:

clientTlsPolicy - clientTlsPolicy or null for none

getClientTlsSettings

public ClientTlsSettings getClientTlsSettings()

[Deprecated] TLS Settings for the backend service.

Returns:

value or null for none

setClientTlsSettings

public SecuritySettings setClientTlsSettings(ClientTlsSettings clientTlsSettings)

[Deprecated] TLS Settings for the backend service.

Parameters:

clientTlsSettings - clientTlsSettings or null for none

getSubjectAltNames

public List<String> getSubjectAltNames()

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.

Returns:

value or null for none

setSubjectAltNames

public SecuritySettings setSubjectAltNames(List<String> subjectAltNames)

Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode). Note: This field currently has no impact.

Parameters:

subjectAltNames - subjectAltNames or null for none

set

public SecuritySettings set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SecuritySettings clone()

Overrides:

clone in class com.google.api.client.json.GenericJson