io.micronaut.kubernetes.client.operator.configuration

Class LeaderElectionConfigurationProperties

java.lang.Object

io.micronaut.kubernetes.client.operator.configuration.LeaderElectionConfigurationProperties

All Implemented Interfaces:

LeaderElectionConfiguration

@ConfigurationProperties(value="kubernetes.client.operator.leader-election.lock")
public class LeaderElectionConfigurationProperties
extends java.lang.Object
implements LeaderElectionConfiguration

ConfigurationProperties implementation of LeaderElectionConfiguration.

Since:

3.3

Author:

Pavol Gressa

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	DEFAULT_LEASE_DURATION_IN_SECONDS
static java.lang.Integer	DEFAULT_RENEW_DEADLINE_IN_SECONDS
static java.lang.Integer	DEFAULT_RETRY_PERIOD_IN_SECONDS
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
LeaderElectionConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getLeaseDuration() The lock lease duration.
java.time.Duration	getRenewDeadline() The lock renew deadline.
java.util.Optional<java.lang.String>	getResourceName() The lock resource name.
java.util.Optional<java.lang.String>	getResourceNamespace() The lock resource namespace.
java.time.Duration	getRetryPeriod() The lock acquire retry period.
void	setLeaseDuration(java.time.Duration leaseDuration) Sets the lock lease duration.
void	setRenewDeadline(java.time.Duration renewDeadline) Sets the lock renew deadline.
void	setResourceName(java.lang.String resourceName) Sets the lock resource name.
void	setResourceNamespace(java.lang.String resourceNamespace) Sets the lock resource namespace.
void	setRetryPeriod(java.time.Duration retryPeriod) Sets the lock acquire retry period.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_LEASE_DURATION_IN_SECONDS

public static final java.lang.Integer DEFAULT_LEASE_DURATION_IN_SECONDS

DEFAULT_RENEW_DEADLINE_IN_SECONDS

public static final java.lang.Integer DEFAULT_RENEW_DEADLINE_IN_SECONDS

DEFAULT_RETRY_PERIOD_IN_SECONDS

public static final java.lang.Integer DEFAULT_RETRY_PERIOD_IN_SECONDS

Constructor Detail

LeaderElectionConfigurationProperties

public LeaderElectionConfigurationProperties()

Method Detail

getLeaseDuration

@NonNull
public java.time.Duration getLeaseDuration()

The lock lease duration. See LeaderElector. Default DEFAULT_LEASE_DURATION_IN_SECONDS.

Specified by:

getLeaseDuration in interface LeaderElectionConfiguration

Returns:

lock lease duration

setLeaseDuration

public void setLeaseDuration(@NonNull
                             java.time.Duration leaseDuration)

Sets the lock lease duration.

Parameters:

leaseDuration - lock lease duration.

getRenewDeadline

@NonNull
public java.time.Duration getRenewDeadline()

The lock renew deadline. If the LeaderElector fails to renew the lock within the deadline then the controller looses the lock. Default DEFAULT_RENEW_DEADLINE_IN_SECONDS.

Specified by:

getRenewDeadline in interface LeaderElectionConfiguration

Returns:

renew deadline

setRenewDeadline

public void setRenewDeadline(@NonNull
                             java.time.Duration renewDeadline)

Sets the lock renew deadline. If the LeaderElector fails to renew the lock within the deadline then the controller looses the lock.

Parameters:

renewDeadline - lock renew deadline.

getRetryPeriod

@NonNull
public java.time.Duration getRetryPeriod()

The lock acquire retry period. See LeaderElector. Default DEFAULT_RETRY_PERIOD_IN_SECONDS.

Specified by:

getRetryPeriod in interface LeaderElectionConfiguration

Returns:

lock acquire retry period.

setRetryPeriod

public void setRetryPeriod(@NonNull
                           java.time.Duration retryPeriod)

Sets the lock acquire retry period.

Parameters:

retryPeriod - lock acquire retry period

getResourceName

@NonNull
public java.util.Optional<java.lang.String> getResourceName()

The lock resource name. If not provided then the application name is used.

Specified by:

getResourceName in interface LeaderElectionConfiguration

Returns:

the lock resource name

setResourceName

public void setResourceName(@NonNull
                            java.lang.String resourceName)

Sets the lock resource name.

Parameters:

resourceName - lock resource name

getResourceNamespace

@NonNull
public java.util.Optional<java.lang.String> getResourceNamespace()

The lock resource namespace. If not provided then the application namespaces is used.

Specified by:

getResourceNamespace in interface LeaderElectionConfiguration

Returns:

the lock resource namespace

setResourceNamespace

public void setResourceNamespace(@NonNull
                                 java.lang.String resourceNamespace)

Sets the lock resource namespace.

Parameters:

resourceNamespace - the lock resource namespace