com.amazonaws.services.opensearch.model

Class OffPeakWindowOptions

java.lang.Object

com.amazonaws.services.opensearch.model.OffPeakWindowOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OffPeakWindowOptions
extends Object
implements Serializable, Cloneable, StructuredPojo

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OffPeakWindowOptions()

Method Summary

Modifier and Type	Method and Description
OffPeakWindowOptions	clone()
boolean	equals(Object obj)
Boolean	getEnabled() Whether to enable an off-peak window.
OffPeakWindow	getOffPeakWindow() Off-peak window settings for the domain.
int	hashCode()
Boolean	isEnabled() Whether to enable an off-peak window.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEnabled(Boolean enabled) Whether to enable an off-peak window.
void	setOffPeakWindow(OffPeakWindow offPeakWindow) Off-peak window settings for the domain.
String	toString() Returns a string representation of this object.
OffPeakWindowOptions	withEnabled(Boolean enabled) Whether to enable an off-peak window.
OffPeakWindowOptions	withOffPeakWindow(OffPeakWindow offPeakWindow) Off-peak window settings for the domain.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OffPeakWindowOptions

public OffPeakWindowOptions()

Method Detail

setEnabled

public void setEnabled(Boolean enabled)

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

Parameters:

enabled - Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

getEnabled

public Boolean getEnabled()

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

Returns:

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

withEnabled

public OffPeakWindowOptions withEnabled(Boolean enabled)

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

Parameters:

enabled - Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

Returns:

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

setOffPeakWindow

public void setOffPeakWindow(OffPeakWindow offPeakWindow)

Off-peak window settings for the domain.

Parameters:

offPeakWindow - Off-peak window settings for the domain.

getOffPeakWindow

public OffPeakWindow getOffPeakWindow()

Off-peak window settings for the domain.

Returns:

Off-peak window settings for the domain.

withOffPeakWindow

public OffPeakWindowOptions withOffPeakWindow(OffPeakWindow offPeakWindow)

Off-peak window settings for the domain.

Parameters:

offPeakWindow - Off-peak window settings for the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public OffPeakWindowOptions clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.