Package software.amazon.awssdk.services.opensearch.model

Class OffPeakWindowOptions

java.lang.Object

software.amazon.awssdk.services.opensearch.model.OffPeakWindowOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OffPeakWindowOptions.Builder,OffPeakWindowOptions>

@Generated("software.amazon.awssdk:codegen")
public final class OffPeakWindowOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OffPeakWindowOptions.Builder,OffPeakWindowOptions>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OffPeakWindowOptions.Builder

Method Summary

Modifier and Type	Method	Description
static OffPeakWindowOptions.Builder	builder()
Boolean	enabled()	Whether to enable an off-peak window.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
OffPeakWindow	offPeakWindow()	Off-peak window settings for the domain.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OffPeakWindowOptions.Builder>	serializableBuilderClass()
OffPeakWindowOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

enabled

public final 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.

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.

offPeakWindow

public final OffPeakWindow offPeakWindow()

Off-peak window settings for the domain.

Returns:

Off-peak window settings for the domain.

toBuilder

public OffPeakWindowOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OffPeakWindowOptions.Builder,OffPeakWindowOptions>

builder

public static OffPeakWindowOptions.Builder builder()

serializableBuilderClass

public static Class<? extends OffPeakWindowOptions.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo