Package org.opensearch.client.opensearch.ism

Class Action.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.Action.Builder

All Implemented Interfaces:

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

Enclosing class:

Action

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

Builder for Action.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final Action.Builder	alias(Function<ActionAlias.Builder,ObjectBuilder<ActionAlias>> fn)	Adds or removes an index alias.
final Action.Builder	alias(ActionAlias value)	Adds or removes an index alias.
final Action.Builder	allocation(Function<ActionAllocation.Builder,ObjectBuilder<ActionAllocation>> fn)	Sets the allocations settings for index.
final Action.Builder	allocation(ActionAllocation value)	Sets the allocations settings for index.
Action	build()	Builds a Action.
final Action.Builder	close(Function<ActionClose.Builder,ObjectBuilder<ActionClose>> fn)	Closes an index.
final Action.Builder	close(ActionClose value)	Closes an index.
Action.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Action.Builder	custom(String key, JsonData value)	Enables custom operations to be performed on the index.
final Action.Builder	custom(Map<String,JsonData> map)	Enables custom operations to be performed on the index.
final Action.Builder	delete(Function<ActionDelete.Builder,ObjectBuilder<ActionDelete>> fn)	Deletes an index.
final Action.Builder	delete(ActionDelete value)	Deletes an index.
final Action.Builder	forceMerge(Function<ActionForceMerge.Builder,ObjectBuilder<ActionForceMerge>> fn)	Force merges an index.
final Action.Builder	forceMerge(ActionForceMerge value)	Force merges an index.
final Action.Builder	indexPriority(Function<ActionIndexPriority.Builder,ObjectBuilder<ActionIndexPriority>> fn)	The priority level of the index.
final Action.Builder	indexPriority(ActionIndexPriority value)	The priority level of the index.
final Action.Builder	notification(String key, JsonData value)	Sets a policy which determines when to send a notification regarding the index.
final Action.Builder	notification(Map<String,JsonData> map)	Sets a policy which determines when to send a notification regarding the index.
final Action.Builder	open(Function<ActionOpen.Builder,ObjectBuilder<ActionOpen>> fn)	Opens an index.
final Action.Builder	open(ActionOpen value)	Opens an index.
final Action.Builder	readOnly(Function<ActionReadOnly.Builder,ObjectBuilder<ActionReadOnly>> fn)	Changes the index permissions to read-only.
final Action.Builder	readOnly(ActionReadOnly value)	Changes the index permissions to read-only.
final Action.Builder	readWrite(Function<ActionReadWrite.Builder,ObjectBuilder<ActionReadWrite>> fn)	Changes the index permissions to read-write.
final Action.Builder	readWrite(ActionReadWrite value)	Changes the index permissions to read-write.
final Action.Builder	replicaCount(Function<ActionReplicaCount.Builder,ObjectBuilder<ActionReplicaCount>> fn)	The number of replicas for the index.
final Action.Builder	replicaCount(ActionReplicaCount value)	The number of replicas for the index.
final Action.Builder	retry(Function<ActionRetry.Builder,ObjectBuilder<ActionRetry>> fn)	The number of times to retry the action.
final Action.Builder	retry(ActionRetry value)	The number of times to retry the action.
final Action.Builder	rollover(Function<ActionRollover.Builder,ObjectBuilder<ActionRollover>> fn)	Sets a rollover policy for the index.
final Action.Builder	rollover(ActionRollover value)	Sets a rollover policy for the index.
final Action.Builder	rollup(String key, JsonData value)	Determines when to perform an index rollup.
final Action.Builder	rollup(Map<String,JsonData> map)	Determines when to perform an index rollup.
final Action.Builder	shrink(String key, JsonData value)	Determines when to shrink the index.
final Action.Builder	shrink(Map<String,JsonData> map)	Determines when to shrink the index.
final Action.Builder	snapshot(Function<ActionSnapshot.Builder,ObjectBuilder<ActionSnapshot>> fn)	Takes a snapshot of the index.
final Action.Builder	snapshot(ActionSnapshot value)	Takes a snapshot of the index.
final Action.Builder	timeout(Function<ActionTimeout.Builder,ObjectBuilder<ActionTimeout>> fn)	The amount of time to wait before the action fails.
final Action.Builder	timeout(ActionTimeout value)	The amount of time to wait before the action fails.
final Action.Builder	transform(String key, JsonData value)	Determines when to perform an index transform.
final Action.Builder	transform(Map<String,JsonData> map)	Determines when to perform an index transform.

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 Action.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<Action.Builder,Action>

Returns:

a new builder instance.

alias

@Nonnull
public final Action.Builder alias(@Nullable
 ActionAlias value)

Adds or removes an index alias.

API name: alias

alias

@Nonnull
public final Action.Builder alias(Function<ActionAlias.Builder,ObjectBuilder<ActionAlias>> fn)

Adds or removes an index alias.

API name: alias

allocation

@Nonnull
public final Action.Builder allocation(@Nullable
 ActionAllocation value)

Sets the allocations settings for index.

API name: allocation

allocation

@Nonnull
public final Action.Builder allocation(Function<ActionAllocation.Builder,ObjectBuilder<ActionAllocation>> fn)

Sets the allocations settings for index.

API name: allocation

close

@Nonnull
public final Action.Builder close(@Nullable
 ActionClose value)

Closes an index.

API name: close

close

@Nonnull
public final Action.Builder close(Function<ActionClose.Builder,ObjectBuilder<ActionClose>> fn)

Closes an index.

API name: close

custom

@Nonnull
public final Action.Builder custom(Map<String,JsonData> map)

Enables custom operations to be performed on the index.

API name: custom

Adds all elements of map to custom.

custom

@Nonnull
public final Action.Builder custom(String key,
 JsonData value)

Enables custom operations to be performed on the index.

API name: custom

Adds an entry to custom.

delete

@Nonnull
public final Action.Builder delete(@Nullable
 ActionDelete value)

Deletes an index.

API name: delete

delete

@Nonnull
public final Action.Builder delete(Function<ActionDelete.Builder,ObjectBuilder<ActionDelete>> fn)

Deletes an index.

API name: delete

forceMerge

@Nonnull
public final Action.Builder forceMerge(@Nullable
 ActionForceMerge value)

Force merges an index.

API name: force_merge

forceMerge

@Nonnull
public final Action.Builder forceMerge(Function<ActionForceMerge.Builder,ObjectBuilder<ActionForceMerge>> fn)

Force merges an index.

API name: force_merge

indexPriority

@Nonnull
public final Action.Builder indexPriority(@Nullable
 ActionIndexPriority value)

The priority level of the index.

API name: index_priority

indexPriority

@Nonnull
public final Action.Builder indexPriority(Function<ActionIndexPriority.Builder,ObjectBuilder<ActionIndexPriority>> fn)

The priority level of the index.

API name: index_priority

notification

@Nonnull
public final Action.Builder notification(Map<String,JsonData> map)

Sets a policy which determines when to send a notification regarding the index.

API name: notification

Adds all elements of map to notification.

notification

@Nonnull
public final Action.Builder notification(String key,
 JsonData value)

Sets a policy which determines when to send a notification regarding the index.

API name: notification

Adds an entry to notification.

open

@Nonnull
public final Action.Builder open(@Nullable
 ActionOpen value)

Opens an index.

API name: open

open

@Nonnull
public final Action.Builder open(Function<ActionOpen.Builder,ObjectBuilder<ActionOpen>> fn)

Opens an index.

API name: open

readOnly

@Nonnull
public final Action.Builder readOnly(@Nullable
 ActionReadOnly value)

Changes the index permissions to read-only.

API name: read_only

readOnly

@Nonnull
public final Action.Builder readOnly(Function<ActionReadOnly.Builder,ObjectBuilder<ActionReadOnly>> fn)

Changes the index permissions to read-only.

API name: read_only

readWrite

@Nonnull
public final Action.Builder readWrite(@Nullable
 ActionReadWrite value)

Changes the index permissions to read-write.

API name: read_write

readWrite

@Nonnull
public final Action.Builder readWrite(Function<ActionReadWrite.Builder,ObjectBuilder<ActionReadWrite>> fn)

Changes the index permissions to read-write.

API name: read_write

replicaCount

@Nonnull
public final Action.Builder replicaCount(@Nullable
 ActionReplicaCount value)

The number of replicas for the index.

API name: replica_count

replicaCount

@Nonnull
public final Action.Builder replicaCount(Function<ActionReplicaCount.Builder,ObjectBuilder<ActionReplicaCount>> fn)

The number of replicas for the index.

API name: replica_count

retry

@Nonnull
public final Action.Builder retry(@Nullable
 ActionRetry value)

The number of times to retry the action.

API name: retry

retry

@Nonnull
public final Action.Builder retry(Function<ActionRetry.Builder,ObjectBuilder<ActionRetry>> fn)

The number of times to retry the action.

API name: retry

rollover

@Nonnull
public final Action.Builder rollover(@Nullable
 ActionRollover value)

Sets a rollover policy for the index.

API name: rollover

rollover

@Nonnull
public final Action.Builder rollover(Function<ActionRollover.Builder,ObjectBuilder<ActionRollover>> fn)

Sets a rollover policy for the index.

API name: rollover

rollup

@Nonnull
public final Action.Builder rollup(Map<String,JsonData> map)

Determines when to perform an index rollup.

API name: rollup

Adds all elements of map to rollup.

rollup

@Nonnull
public final Action.Builder rollup(String key,
 JsonData value)

Determines when to perform an index rollup.

API name: rollup

Adds an entry to rollup.

shrink

@Nonnull
public final Action.Builder shrink(Map<String,JsonData> map)

Determines when to shrink the index.

API name: shrink

Adds all elements of map to shrink.

shrink

@Nonnull
public final Action.Builder shrink(String key,
 JsonData value)

Determines when to shrink the index.

API name: shrink

Adds an entry to shrink.

snapshot

@Nonnull
public final Action.Builder snapshot(@Nullable
 ActionSnapshot value)

Takes a snapshot of the index.

API name: snapshot

snapshot

@Nonnull
public final Action.Builder snapshot(Function<ActionSnapshot.Builder,ObjectBuilder<ActionSnapshot>> fn)

Takes a snapshot of the index.

API name: snapshot

timeout

@Nonnull
public final Action.Builder timeout(@Nullable
 ActionTimeout value)

The amount of time to wait before the action fails.

API name: timeout

timeout

@Nonnull
public final Action.Builder timeout(Function<ActionTimeout.Builder,ObjectBuilder<ActionTimeout>> fn)

The amount of time to wait before the action fails.

API name: timeout

transform

@Nonnull
public final Action.Builder transform(Map<String,JsonData> map)

Determines when to perform an index transform.

API name: transform

Adds all elements of map to transform.

transform

@Nonnull
public final Action.Builder transform(String key,
 JsonData value)

Determines when to perform an index transform.

API name: transform

Adds an entry to transform.

build

@Nonnull
public Action build()

Builds a Action.

Specified by:

build in interface ObjectBuilder<Action>

Throws:

NullPointerException - if some of the required fields are null.