ProvidersTypes.Oauth2Info (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.vcenter.identity.ProvidersTypes.Oauth2Info

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

ProvidersTypes
```
public static final class ProvidersTypes.Oauth2Info
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The Oauth2Info class contains the information about an OAuth2 identity provider. This class was added in vSphere API 7.0.0.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProvidersTypes.Oauth2Info.Builder
Builder class for ProvidersTypes.Oauth2Info.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProvidersTypes.Oauth2Info.Builder` Builder class for `ProvidersTypes.Oauth2Info`.

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

Oauth2Info()
Default constructor.

protected Oauth2Info(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Oauth2Info()` Default constructor.
`protected`	`Oauth2Info(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static ProvidersTypes.Oauth2Info`	`_newInstance(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static ProvidersTypes.Oauth2Info`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`java.net.URI`	`getAuthEndpoint()` Authentication/authorization endpoint of the provider.
`ProvidersTypes.Oauth2AuthenticationMethod`	`getAuthenticationMethod()` Authentication method used by the provider.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getAuthQueryParams()` key/value pairs that are to be appended to the authEndpoint request.
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>>`	`getClaimMap()` The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands.
`java.lang.String`	`getClientId()` Client identifier to connect to the provider.
`java.lang.String`	`getClientSecret()` The secret shared between the client and the provider.
`java.lang.String`	`getIssuer()` The identity provider namespace.
`java.net.URI`	`getPublicKeyUri()` Endpoint to retrieve the provider public key for validation.
`java.net.URI`	`getTokenEndpoint()` Token endpoint of the provider.
`int`	`hashCode()`
`void`	`setAuthEndpoint(java.net.URI authEndpoint)` Authentication/authorization endpoint of the provider.
`void`	`setAuthenticationMethod(ProvidersTypes.Oauth2AuthenticationMethod authenticationMethod)` Authentication method used by the provider.
`void`	`setAuthQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> authQueryParams)` key/value pairs that are to be appended to the authEndpoint request.
`void`	`setClaimMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>> claimMap)` The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands.
`void`	`setClientId(java.lang.String clientId)` Client identifier to connect to the provider.
`void`	`setClientSecret(java.lang.String clientSecret)` The secret shared between the client and the provider.
`void`	`setIssuer(java.lang.String issuer)` The identity provider namespace.
`void`	`setPublicKeyUri(java.net.URI publicKeyUri)` Endpoint to retrieve the provider public key for validation.
`void`	`setTokenEndpoint(java.net.URI tokenEndpoint)` Token endpoint of the provider.
`java.lang.String`	`toString()` Returns a string representation of this structure.

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

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - Oauth2Info
```
public Oauth2Info()
```
    Default constructor.
  - Oauth2Info
```
protected Oauth2Info(StructValue __dynamicStructureFields)
```
- Method Detail
  - getAuthEndpoint
```
public java.net.URI getAuthEndpoint()
```
    Authentication/authorization endpoint of the provider. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setAuthEndpoint
```
public void setAuthEndpoint(java.net.URI authEndpoint)
```
    Authentication/authorization endpoint of the provider. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    authEndpoint - New value for the property.
  - getTokenEndpoint
```
public java.net.URI getTokenEndpoint()
```
    Token endpoint of the provider. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setTokenEndpoint
```
public void setTokenEndpoint(java.net.URI tokenEndpoint)
```
    Token endpoint of the provider. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    tokenEndpoint - New value for the property.
  - getPublicKeyUri
```
public java.net.URI getPublicKeyUri()
```
    Endpoint to retrieve the provider public key for validation. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setPublicKeyUri
```
public void setPublicKeyUri(java.net.URI publicKeyUri)
```
    Endpoint to retrieve the provider public key for validation. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    publicKeyUri - New value for the property.
  - getClientId
```
public java.lang.String getClientId()
```
    Client identifier to connect to the provider. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setClientId
```
public void setClientId(java.lang.String clientId)
```
    Client identifier to connect to the provider. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    clientId - New value for the property.
  - getClientSecret
```
public java.lang.String getClientSecret()
```
    The secret shared between the client and the provider. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setClientSecret
```
public void setClientSecret(java.lang.String clientSecret)
```
    The secret shared between the client and the provider. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    clientSecret - New value for the property.
  - getClaimMap
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>> getClaimMap()
```
    The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setClaimMap
```
public void setClaimMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.List<java.lang.String>>> claimMap)
```
    The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    claimMap - New value for the property.
  - getIssuer
```
public java.lang.String getIssuer()
```
    The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setIssuer
```
public void setIssuer(java.lang.String issuer)
```
    The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    issuer - New value for the property.
  - getAuthenticationMethod
```
public ProvidersTypes.Oauth2AuthenticationMethod getAuthenticationMethod()
```
    Authentication method used by the provider. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setAuthenticationMethod
```
public void setAuthenticationMethod(ProvidersTypes.Oauth2AuthenticationMethod authenticationMethod)
```
    Authentication method used by the provider. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    authenticationMethod - New value for the property.
  - getAuthQueryParams
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAuthQueryParams()
```
    key/value pairs that are to be appended to the authEndpoint request.
    
    How to append to authEndpoint request:
    If the map is not empty, a "?" is added to the endpoint URL, and combination of each k and each string in the v is added with an "&" delimiter. Details:
    - If the value contains only one string, then the key is added with "k=v".
    - If the value is an empty list, then the key is added without a "=v".
    - If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
    . This property was added in vSphere API 7.0.0.0.
    Returns:
    
    The current value of the property.
  - setAuthQueryParams
```
public void setAuthQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> authQueryParams)
```
    key/value pairs that are to be appended to the authEndpoint request.
    
    How to append to authEndpoint request:
    If the map is not empty, a "?" is added to the endpoint URL, and combination of each k and each string in the v is added with an "&" delimiter. Details:
    - If the value contains only one string, then the key is added with "k=v".
    - If the value is an empty list, then the key is added without a "=v".
    - If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.
    . This property was added in vSphere API 7.0.0.0.
    Parameters:
    
    authQueryParams - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public java.lang.String _getCanonicalName()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static ProvidersTypes.Oauth2Info _newInstance(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2
```
public static ProvidersTypes.Oauth2Info _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class ProvidersTypes.Oauth2Info

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

Oauth2Info

Oauth2Info

Method Detail

getAuthEndpoint

setAuthEndpoint

getTokenEndpoint

setTokenEndpoint

getPublicKeyUri

setPublicKeyUri

getClientId

setClientId

getClientSecret

setClientSecret

getClaimMap

setClaimMap

getIssuer

setIssuer

getAuthenticationMethod

setAuthenticationMethod

getAuthQueryParams

setAuthQueryParams

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2