Package org.opensearch.client.opensearch.ism

Class Policy.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.Policy.Builder

All Implemented Interfaces:

CopyableBuilder<Policy.Builder,Policy>, MutableBuilder<Policy.Builder,Policy>, ObjectBuilder<Policy>

Enclosing class:

Policy

public static class Policy.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Policy.Builder,Policy>

Builder for Policy.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Policy	build()	Builds a Policy.
Policy.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Policy.Builder	defaultState(String value)	The default state an index is in.
final Policy.Builder	description(String value)	The description of the policy.
final Policy.Builder	errorNotification(Function<ErrorNotification.Builder,ObjectBuilder<ErrorNotification>> fn)	The configuration for error notifications.
final Policy.Builder	errorNotification(ErrorNotification value)	The configuration for error notifications.
final Policy.Builder	ismTemplate(Function<IsmTemplate.Builder,ObjectBuilder<IsmTemplate>> fn)	The ISM template configuration.
final Policy.Builder	ismTemplate(List<IsmTemplate> list)	The ISM template configuration.
final Policy.Builder	ismTemplate(IsmTemplate value, IsmTemplate... values)	The ISM template configuration.
final Policy.Builder	lastUpdatedTime(Integer value)	When the policy was last updated.
final Policy.Builder	policyId(String value)	The unique identifier for the policy.
final Policy.Builder	schemaVersion(Number value)	The version of the policy schema.
final Policy.Builder	states(Function<States.Builder,ObjectBuilder<States>> fn)	The list of states for the index to transition between.
final Policy.Builder	states(List<States> list)	The list of states for the index to transition between.
final Policy.Builder	states(States value, States... values)	The list of states for the index to transition between.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public Policy.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<Policy.Builder,Policy>

Returns:

a new builder instance.

defaultState

@Nonnull
public final Policy.Builder defaultState(@Nullable
 String value)

The default state an index is in.

API name: default_state

description

@Nonnull
public final Policy.Builder description(@Nullable
 String value)

The description of the policy.

API name: description

errorNotification

@Nonnull
public final Policy.Builder errorNotification(@Nullable
 ErrorNotification value)

The configuration for error notifications.

API name: error_notification

errorNotification

@Nonnull
public final Policy.Builder errorNotification(Function<ErrorNotification.Builder,ObjectBuilder<ErrorNotification>> fn)

The configuration for error notifications.

API name: error_notification

ismTemplate

@Nonnull
public final Policy.Builder ismTemplate(List<IsmTemplate> list)

The ISM template configuration.

API name: ism_template

Adds all elements of list to ismTemplate.

ismTemplate

@Nonnull
public final Policy.Builder ismTemplate(IsmTemplate value,
 IsmTemplate... values)

The ISM template configuration.

API name: ism_template

Adds one or more values to ismTemplate.

ismTemplate

@Nonnull
public final Policy.Builder ismTemplate(Function<IsmTemplate.Builder,ObjectBuilder<IsmTemplate>> fn)

The ISM template configuration.

API name: ism_template

Adds a value to ismTemplate using a builder lambda.

lastUpdatedTime

@Nonnull
public final Policy.Builder lastUpdatedTime(@Nullable
 Integer value)

When the policy was last updated.

API name: last_updated_time

policyId

@Nonnull
public final Policy.Builder policyId(@Nullable
 String value)

The unique identifier for the policy.

API name: policy_id

schemaVersion

@Nonnull
public final Policy.Builder schemaVersion(@Nullable
 Number value)

The version of the policy schema.

API name: schema_version

states

@Nonnull
public final Policy.Builder states(List<States> list)

The list of states for the index to transition between.

API name: states

Adds all elements of list to states.

states

@Nonnull
public final Policy.Builder states(States value,
 States... values)

The list of states for the index to transition between.

API name: states

Adds one or more values to states.

states

@Nonnull
public final Policy.Builder states(Function<States.Builder,ObjectBuilder<States>> fn)

The list of states for the index to transition between.

API name: states

Adds a value to states using a builder lambda.

build

@Nonnull
public Policy build()

Builds a Policy.

Specified by:

build in interface ObjectBuilder<Policy>

Throws:

NullPointerException - if some of the required fields are null.