Klasse AdminShutdown

java.lang.Object

io.github.primelib.webmethodsapigateway4j.models.AdminShutdown

@Generated("io.github.primelib.primecodegen")
public class AdminShutdown
extends Object

AdminShutdown

This contains parameters for APIGateway shutdown resource.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected Boolean	bounce	Specifies whether to restart API Gateway server after shutdown.
protected String	option	Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended.
protected Boolean	quiesce	A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server.
protected Integer	timeout	Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	AdminShutdown()
	AdminShutdown(Boolean bounce, String option, Boolean quiesce, Integer timeout)	Constructs a validated instance of AdminShutdown.
	AdminShutdown(Consumer<AdminShutdown> spec)	Constructs a validated instance of AdminShutdown.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Boolean	bounce()	Specifies whether to restart API Gateway server after shutdown.
AdminShutdown	bounce(Boolean bounce)	Specifies whether to restart API Gateway server after shutdown.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
String	option()	Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended.
AdminShutdown	option(String option)	Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended.
Boolean	quiesce()	A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server.
AdminShutdown	quiesce(Boolean quiesce)	A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server.
Integer	timeout()	Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.
AdminShutdown	timeout(Integer timeout)	Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

bounce

protected Boolean bounce

Specifies whether to restart API Gateway server after shutdown. A value of true would restart the server. Default value is false.

option

protected String option

Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended. A value of 'force' would shutdown the server immediately and 'drain' would wait for a maximum period of time for all the client sessions to end before shutdown.

quiesce

protected Boolean quiesce

A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server. Next, when API Gateway is restarted either manually or using bounce parameter, the Integration server will be started in Quiesce mode. Note: In a cluster, the flushing of in memory data would happen only on one of the nodes and hence on other nodes the API call would return immediately by eliminating the flush time. The default value is false.

timeout

protected Integer timeout

Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.

Konstruktordetails

AdminShutdown

public AdminShutdown(Consumer<AdminShutdown> spec)

Constructs a validated instance of AdminShutdown.

Parameter:

spec - the specification to process

AdminShutdown

@Internal
public AdminShutdown(Boolean bounce,
 String option,
 Boolean quiesce,
 Integer timeout)

Constructs a validated instance of AdminShutdown.

NOTE: This constructor is not considered stable and may change if the model is updated. Consider using AdminShutdown(Consumer) instead.

Parameter:

bounce - Specifies whether to restart API Gateway server after shutdown. A value of true would restart the server. Default value is false.

option - Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended. A value of 'force' would shutdown the server immediately and 'drain' would wait for a maximum period of time for all the client sessions to end before shutdown.

quiesce - A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server. Next, when API Gateway is restarted either manually or using bounce parameter, the Integration server will be started in Quiesce mode. Note: In a cluster, the flushing of in memory data would happen only on one of the nodes and hence on other nodes the API call would return immediately by eliminating the flush time. The default value is false.

timeout - Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.

AdminShutdown

protected AdminShutdown()

Methodendetails

bounce

public Boolean bounce()

Specifies whether to restart API Gateway server after shutdown. A value of true would restart the server. Default value is false.

option

public String option()

Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended. A value of 'force' would shutdown the server immediately and 'drain' would wait for a maximum period of time for all the client sessions to end before shutdown.

quiesce

public Boolean quiesce()

A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server. Next, when API Gateway is restarted either manually or using bounce parameter, the Integration server will be started in Quiesce mode. Note: In a cluster, the flushing of in memory data would happen only on one of the nodes and hence on other nodes the API call would return immediately by eliminating the flush time. The default value is false.

timeout

public Integer timeout()

Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.

bounce

public AdminShutdown bounce(Boolean bounce)

Specifies whether to restart API Gateway server after shutdown. A value of true would restart the server. Default value is false.

Gibt zurück:

this.

option

public AdminShutdown option(String option)

Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended. A value of 'force' would shutdown the server immediately and 'drain' would wait for a maximum period of time for all the client sessions to end before shutdown.

Gibt zurück:

this.

quiesce

public AdminShutdown quiesce(Boolean quiesce)

A value of true would first flush the API Gateway in memory data like performance metrics, license metrics and subscription quota to datastore before shutdown of the server. Next, when API Gateway is restarted either manually or using bounce parameter, the Integration server will be started in Quiesce mode. Note: In a cluster, the flushing of in memory data would happen only on one of the nodes and hence on other nodes the API call would return immediately by eliminating the flush time. The default value is false.

Gibt zurück:

this.

timeout

public AdminShutdown timeout(Integer timeout)

Specifies the maximum wait time in minutes before API Gateway server is shutdown when option drain is specified.

Gibt zurück:

this.

equals

public boolean equals(Object o)

Setzt außer Kraft:

equals in Klasse Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Setzt außer Kraft:

hashCode in Klasse Object

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object