com.vmware.nsx.model

Class OidcHealthCheckError

java.lang.Object

com.vmware.nsx.model.OidcHealthCheckError

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class OidcHealthCheckError
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

Details about an error encountered while checking OIDC End Point health status.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OidcHealthCheckError.Builder Builder class for OidcHealthCheckError.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	ERROR_TYPE_JWKS_URI_FETCH_FAIL
static java.lang.String	ERROR_TYPE_SCIM_SEARCH_FAIL
static java.lang.String	ERROR_TYPE_TOKEN_RETRIEVE_FAIL

Constructor Summary

Constructors

Modifier	Constructor and Description
	OidcHealthCheckError() Default constructor.
protected	OidcHealthCheckError(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
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.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static OidcHealthCheckError	_newInstance(com.vmware.vapi.data.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 OidcHealthCheckError	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.String	getErrorDetail() Additional details about the cause of the error, if any could be determined.
java.lang.String	getErrorType() Possible values are: ERROR_TYPE_JWKS_URI_FETCH_FAIL ERROR_TYPE_TOKEN_RETRIEVE_FAIL ERROR_TYPE_SCIM_SEARCH_FAIL A problem discovered when checking the health of the OIDC End Point.
int	hashCode()
void	setErrorDetail(java.lang.String errorDetail) Additional details about the cause of the error, if any could be determined.
void	setErrorType(java.lang.String errorType) Possible values are: ERROR_TYPE_JWKS_URI_FETCH_FAIL ERROR_TYPE_TOKEN_RETRIEVE_FAIL ERROR_TYPE_SCIM_SEARCH_FAIL A problem discovered when checking the health of the OIDC End Point.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ERROR_TYPE_JWKS_URI_FETCH_FAIL

public static final java.lang.String ERROR_TYPE_JWKS_URI_FETCH_FAIL

See Also:

Constant Field Values

ERROR_TYPE_TOKEN_RETRIEVE_FAIL

public static final java.lang.String ERROR_TYPE_TOKEN_RETRIEVE_FAIL

See Also:

Constant Field Values

ERROR_TYPE_SCIM_SEARCH_FAIL

public static final java.lang.String ERROR_TYPE_SCIM_SEARCH_FAIL

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

OidcHealthCheckError

public OidcHealthCheckError()

Default constructor.

OidcHealthCheckError

protected OidcHealthCheckError(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getErrorDetail

public java.lang.String getErrorDetail()

Additional details about the cause of the error, if any could be determined.

Returns:

The current value of the property.

setErrorDetail

public void setErrorDetail(java.lang.String errorDetail)

Additional details about the cause of the error, if any could be determined.

Parameters:

errorDetail - New value for the property.

getErrorType

public java.lang.String getErrorType()

Possible values are:

• ERROR_TYPE_JWKS_URI_FETCH_FAIL
• ERROR_TYPE_TOKEN_RETRIEVE_FAIL
• ERROR_TYPE_SCIM_SEARCH_FAIL

A problem discovered when checking the health of the OIDC End Point. DISCOVERY_URI_FETCH_FAIL: The OIDC discovery endpoint could not be retrieved. TOKEN_RETRIEVE_FAIL: NSX was unable to retrieve a token from the OIDC End Point. Authentication to NSX using OIDC will not be possible. SCIM_SEARCH_FAIL: NSX was unable to perform a user/group search of the SCIM (System for Cross-domain Identity Management) endpoint. User and group searches will not function correctly. GENERAL_ERROR: Some general error occurred while verifying the OIDC endpoint.

Returns:

The current value of the property.

setErrorType

public void setErrorType(java.lang.String errorType)

Possible values are:

• ERROR_TYPE_JWKS_URI_FETCH_FAIL
• ERROR_TYPE_TOKEN_RETRIEVE_FAIL
• ERROR_TYPE_SCIM_SEARCH_FAIL

A problem discovered when checking the health of the OIDC End Point. DISCOVERY_URI_FETCH_FAIL: The OIDC discovery endpoint could not be retrieved. TOKEN_RETRIEVE_FAIL: NSX was unable to retrieve a token from the OIDC End Point. Authentication to NSX using OIDC will not be possible. SCIM_SEARCH_FAIL: NSX was unable to perform a user/group search of the SCIM (System for Cross-domain Identity Management) endpoint. User and group searches will not function correctly. GENERAL_ERROR: Some general error occurred while verifying the OIDC endpoint.

Parameters:

errorType - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.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()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

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

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static OidcHealthCheckError _newInstance(com.vmware.vapi.data.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 OidcHealthCheckError _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.