Package io.fabric8.openshift.api.model.config.v1

Class OIDCClientStatus

java.lang.Object

io.fabric8.openshift.api.model.config.v1.OIDCClientStatus

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<OIDCClientStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class OIDCClientStatus
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<OIDCClientStatusBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

OIDCClientStatus represents the current state of platform components and how they interact with the configured identity providers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OIDCClientStatus()	No args constructor for use in serialization
OIDCClientStatus(String componentName, String componentNamespace, List<io.fabric8.kubernetes.api.model.Condition> conditions, List<String> consumingUsers, List<OIDCClientReference> currentOIDCClients)

Method Summary

Modifier and Type	Method	Description
OIDCClientStatusBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getComponentName()	componentName is a required field that specifies the name of the platform component using the identity provider as an authentication mode.
String	getComponentNamespace()	componentNamespace is a required field that specifies the namespace in which the platform component using the identity provider as an authentication mode is running.
List<io.fabric8.kubernetes.api.model.Condition>	getConditions()	conditions are used to communicate the state of the `oidcClients` entry.
List<String>	getConsumingUsers()	consumingUsers is an optional list of ServiceAccounts requiring read permissions on the `clientSecret` secret.
List<OIDCClientReference>	getCurrentOIDCClients()	currentOIDCClients is an optional list of clients that the component is currently using.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setComponentName(String componentName)	componentName is a required field that specifies the name of the platform component using the identity provider as an authentication mode.
void	setComponentNamespace(String componentNamespace)	componentNamespace is a required field that specifies the namespace in which the platform component using the identity provider as an authentication mode is running.
void	setConditions(List<io.fabric8.kubernetes.api.model.Condition> conditions)	conditions are used to communicate the state of the `oidcClients` entry.
void	setConsumingUsers(List<String> consumingUsers)	consumingUsers is an optional list of ServiceAccounts requiring read permissions on the `clientSecret` secret.
void	setCurrentOIDCClients(List<OIDCClientReference> currentOIDCClients)	currentOIDCClients is an optional list of clients that the component is currently using.
OIDCClientStatusBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OIDCClientStatus

public OIDCClientStatus()

No args constructor for use in serialization

OIDCClientStatus

public OIDCClientStatus(String componentName,
                        String componentNamespace,
                        List<io.fabric8.kubernetes.api.model.Condition> conditions,
                        List<String> consumingUsers,
                        List<OIDCClientReference> currentOIDCClients)

Method Detail

getComponentName

public String getComponentName()

componentName is a required field that specifies the name of the platform component using the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.

componentName must not be an empty string ("") and must not exceed 256 characters in length.

setComponentName

public void setComponentName(String componentName)

componentName is a required field that specifies the name of the platform component using the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.

componentName must not be an empty string ("") and must not exceed 256 characters in length.

getComponentNamespace

public String getComponentNamespace()

componentNamespace is a required field that specifies the namespace in which the platform component using the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.

componentNamespace must not be an empty string ("") and must not exceed 63 characters in length.

setComponentNamespace

public void setComponentNamespace(String componentNamespace)

componentNamespace is a required field that specifies the namespace in which the platform component using the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.

componentNamespace must not be an empty string ("") and must not exceed 63 characters in length.

getConditions

public List<io.fabric8.kubernetes.api.model.Condition> getConditions()

conditions are used to communicate the state of the `oidcClients` entry.

Supported conditions include Available, Degraded and Progressing.

If Available is true, the component is successfully using the configured client. If Degraded is true, that means something has gone wrong trying to handle the client configuration. If Progressing is true, that means the component is taking some action related to the `oidcClients` entry.

setConditions

public void setConditions(List<io.fabric8.kubernetes.api.model.Condition> conditions)

conditions are used to communicate the state of the `oidcClients` entry.

Supported conditions include Available, Degraded and Progressing.

If Available is true, the component is successfully using the configured client. If Degraded is true, that means something has gone wrong trying to handle the client configuration. If Progressing is true, that means the component is taking some action related to the `oidcClients` entry.

getConsumingUsers

public List<String> getConsumingUsers()

consumingUsers is an optional list of ServiceAccounts requiring read permissions on the `clientSecret` secret.

consumingUsers must not exceed 5 entries.

setConsumingUsers

public void setConsumingUsers(List<String> consumingUsers)

consumingUsers is an optional list of ServiceAccounts requiring read permissions on the `clientSecret` secret.

consumingUsers must not exceed 5 entries.

getCurrentOIDCClients

public List<OIDCClientReference> getCurrentOIDCClients()

currentOIDCClients is an optional list of clients that the component is currently using. Entries must have unique issuerURL/clientID pairs.

setCurrentOIDCClients

public void setCurrentOIDCClients(List<OIDCClientReference> currentOIDCClients)

currentOIDCClients is an optional list of clients that the component is currently using. Entries must have unique issuerURL/clientID pairs.

edit

public OIDCClientStatusBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<OIDCClientStatusBuilder>

toBuilder

public OIDCClientStatusBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)