Class Action.Builder
- All Implemented Interfaces:
CopyableBuilder<Action.Builder,,Action> MutableBuilder<Action.Builder,,Action> ObjectBuilder<Action>
- Enclosing class:
Action
Action.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal Action.BuilderAdds or removes an index alias.final Action.Builderalias(ActionAlias value) Adds or removes an index alias.final Action.BuilderSets the allocations settings for index.final Action.Builderallocation(ActionAllocation value) Sets the allocations settings for index.build()Builds aAction.final Action.BuilderCloses an index.final Action.Builderclose(ActionClose value) Closes an index.copy()Create a new builderCopyableBuilderthat is a copy of this one.final Action.BuilderEnables custom operations to be performed on the index.final Action.BuilderEnables custom operations to be performed on the index.final Action.BuilderDeletes an index.final Action.Builderdelete(ActionDelete value) Deletes an index.final Action.BuilderForce merges an index.final Action.BuilderforceMerge(ActionForceMerge value) Force merges an index.final Action.BuilderThe priority level of the index.final Action.BuilderindexPriority(ActionIndexPriority value) The priority level of the index.final Action.Buildernotification(String key, JsonData value) Sets a policy which determines when to send a notification regarding the index.final Action.Buildernotification(Map<String, JsonData> map) Sets a policy which determines when to send a notification regarding the index.final Action.BuilderOpens an index.final Action.Builderopen(ActionOpen value) Opens an index.final Action.BuilderChanges the index permissions to read-only.final Action.BuilderreadOnly(ActionReadOnly value) Changes the index permissions to read-only.final Action.BuilderChanges the index permissions to read-write.final Action.BuilderreadWrite(ActionReadWrite value) Changes the index permissions to read-write.final Action.BuilderThe number of replicas for the index.final Action.BuilderreplicaCount(ActionReplicaCount value) The number of replicas for the index.final Action.BuilderThe number of times to retry the action.final Action.Builderretry(ActionRetry value) The number of times to retry the action.final Action.BuilderSets a rollover policy for the index.final Action.Builderrollover(ActionRollover value) Sets a rollover policy for the index.final Action.BuilderDetermines when to perform an index rollup.final Action.BuilderDetermines when to perform an index rollup.final Action.BuilderDetermines when to shrink the index.final Action.BuilderDetermines when to shrink the index.final Action.BuilderTakes a snapshot of the index.final Action.Buildersnapshot(ActionSnapshot value) Takes a snapshot of the index.final Action.BuilderThe amount of time to wait before the action fails.final Action.Buildertimeout(ActionTimeout value) The amount of time to wait before the action fails.final Action.BuilderDetermines when to perform an index transform.final Action.BuilderDetermines when to perform an index transform.Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<Action.Builder,Action> - Returns:
- a new builder instance.
-
alias
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
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
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
Enables custom operations to be performed on the index.API name:
customAdds all elements of
maptocustom. -
custom
Enables custom operations to be performed on the index.API name:
customAdds an entry to
custom. -
delete
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
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
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
Sets a policy which determines when to send a notification regarding the index.API name:
notificationAdds all elements of
maptonotification. -
notification
Sets a policy which determines when to send a notification regarding the index.API name:
notificationAdds an entry to
notification. -
open
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
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
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
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
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
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
Determines when to perform an index rollup.API name:
rollupAdds all elements of
maptorollup. -
rollup
Determines when to perform an index rollup.API name:
rollupAdds an entry to
rollup. -
shrink
Determines when to shrink the index.API name:
shrinkAdds all elements of
maptoshrink. -
shrink
Determines when to shrink the index.API name:
shrinkAdds an entry to
shrink. -
snapshot
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
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
Determines when to perform an index transform.API name:
transformAdds all elements of
maptotransform. -
transform
Determines when to perform an index transform.API name:
transformAdds an entry to
transform. -
build
Builds aAction.- Specified by:
buildin interfaceObjectBuilder<Action>- Throws:
NullPointerException- if some of the required fields are null.
-