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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250107-2.0.0

Show newest version







AuthenticationPolicy (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 AuthenticationPolicy



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













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




public final class AuthenticationPolicy
extends GenericJson
[Deprecated] The authentication settings for the backend service. The authentication settings for
 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


AuthenticationPolicy() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AuthenticationPolicy
clone() 


List<OriginAuthenticationMethod>
getOrigins()
List of authentication methods that can be used for origin authentication.



List<PeerAuthenticationMethod>
getPeers()
List of authentication methods that can be used for peer authentication.



String
getPrincipalBinding()
Define whether peer or origin identity should be used for principal.



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



AuthenticationPolicy
set(String fieldName,
   Object value) 


AuthenticationPolicy
setOrigins(List<OriginAuthenticationMethod> origins)
List of authentication methods that can be used for origin authentication.



AuthenticationPolicy
setPeers(List<PeerAuthenticationMethod> peers)
List of authentication methods that can be used for peer authentication.



AuthenticationPolicy
setPrincipalBinding(String principalBinding)
Define whether peer or origin identity should be used for principal.



AuthenticationPolicy
setServerTlsContext(TlsContext serverTlsContext)
Configures the mechanism to obtain server-side security certificates and identity information.







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





AuthenticationPolicy
public AuthenticationPolicy()









Method Detail





getOrigins
public List<OriginAuthenticationMethod> getOrigins()
List of authentication methods that can be used for origin authentication. Similar to peers,
 these will be evaluated in order the first valid one will be used to set origin identity. If
 none of these methods pass, the request will be rejected with authentication failed error
 (401). Leave the list empty if origin authentication is not required.

Returns:
value or null for none








setOrigins
public AuthenticationPolicy setOrigins(List<OriginAuthenticationMethod> origins)
List of authentication methods that can be used for origin authentication. Similar to peers,
 these will be evaluated in order the first valid one will be used to set origin identity. If
 none of these methods pass, the request will be rejected with authentication failed error
 (401). Leave the list empty if origin authentication is not required.

Parameters:
origins - origins or null for none








getPeers
public List<PeerAuthenticationMethod> getPeers()
List of authentication methods that can be used for peer authentication. They will be evaluated
 in order the first valid one will be used to set peer identity. If none of these methods pass,
 the request will be rejected with authentication failed error (401). Leave the list empty if
 peer authentication is not required.

Returns:
value or null for none








setPeers
public AuthenticationPolicy setPeers(List<PeerAuthenticationMethod> peers)
List of authentication methods that can be used for peer authentication. They will be evaluated
 in order the first valid one will be used to set peer identity. If none of these methods pass,
 the request will be rejected with authentication failed error (401). Leave the list empty if
 peer authentication is not required.

Parameters:
peers - peers or null for none








getPrincipalBinding
public String getPrincipalBinding()
Define whether peer or origin identity should be used for principal. Default value is USE_PEER.
 If peer (or origin) identity is not available, either because peer/origin authentication is not
 defined, or failed, principal will be left unset. In other words, binding rule does not affect
 the decision to accept or reject request. This field can be set to one of the following:
 USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal
 will be set to the identity from origin authentication.

Returns:
value or null for none








setPrincipalBinding
public AuthenticationPolicy setPrincipalBinding(String principalBinding)
Define whether peer or origin identity should be used for principal. Default value is USE_PEER.
 If peer (or origin) identity is not available, either because peer/origin authentication is not
 defined, or failed, principal will be left unset. In other words, binding rule does not affect
 the decision to accept or reject request. This field can be set to one of the following:
 USE_PEER: Principal will be set to the identity from peer authentication. USE_ORIGIN: Principal
 will be set to the identity from origin authentication.

Parameters:
principalBinding - principalBinding or null for none








getServerTlsContext
public TlsContext getServerTlsContext()
Configures the mechanism to obtain server-side security certificates and identity information.

Returns:
value or null for none








setServerTlsContext
public AuthenticationPolicy setServerTlsContext(TlsContext serverTlsContext)
Configures the mechanism to obtain server-side security certificates and identity information.

Parameters:
serverTlsContext - serverTlsContext or null for none








set
public AuthenticationPolicy set(String fieldName,
                                Object value)

Overrides:
set in class GenericJson








clone
public AuthenticationPolicy 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
`AuthenticationPolicy`	`clone()`
`List<OriginAuthenticationMethod>`	`getOrigins()` List of authentication methods that can be used for origin authentication.
`List<PeerAuthenticationMethod>`	`getPeers()` List of authentication methods that can be used for peer authentication.
`String`	`getPrincipalBinding()` Define whether peer or origin identity should be used for principal.
`TlsContext`	`getServerTlsContext()` Configures the mechanism to obtain server-side security certificates and identity information.
`AuthenticationPolicy`	`set(String fieldName, Object value)`
`AuthenticationPolicy`	`setOrigins(List<OriginAuthenticationMethod> origins)` List of authentication methods that can be used for origin authentication.
`AuthenticationPolicy`	`setPeers(List<PeerAuthenticationMethod> peers)` List of authentication methods that can be used for peer authentication.
`AuthenticationPolicy`	`setPrincipalBinding(String principalBinding)` Define whether peer or origin identity should be used for principal.
`AuthenticationPolicy`	`setServerTlsContext(TlsContext serverTlsContext)` Configures the mechanism to obtain server-side security certificates and identity information.