Class CreateRepositoryRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<CreateRepositoryRequest.Builder>
org.opensearch.client.opensearch.snapshot.CreateRepositoryRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<CreateRepositoryRequest.Builder,,CreateRepositoryRequest> MutableBuilder<CreateRepositoryRequest.Builder,,CreateRepositoryRequest> ObjectBuilder<CreateRepositoryRequest>
- Enclosing class:
CreateRepositoryRequest
public static class CreateRepositoryRequest.Builder
extends RequestBase.AbstractBuilder<CreateRepositoryRequest.Builder>
implements CopyableBuilder<CreateRepositoryRequest.Builder,CreateRepositoryRequest>
Builder for
CreateRepositoryRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aCreateRepositoryRequest.The amount of time to wait for a response from the cluster manager node.clusterManagerTimeout(Time value) The amount of time to wait for a response from the cluster manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.Deprecated.masterTimeout(Time value) Deprecated.Required - The name for the newly registered repository.API name:repositoryrepository(Repository value) API name:repositoryprotected CreateRepositoryRequest.Builderself()Required - API name:settingssettings(RepositorySettings value) Required - API name:settingsThe amount of time to wait for a response.The amount of time to wait for a response.Required - API name:typeWhentrue, verifies the creation of the snapshot repository.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder
errorTrace, humanMethods 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<CreateRepositoryRequest.Builder,CreateRepositoryRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<CreateRepositoryRequest.Builder>
-
clusterManagerTimeout
The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.API name:
cluster_manager_timeout -
clusterManagerTimeout
@Nonnull public final CreateRepositoryRequest.Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.API name:
cluster_manager_timeout -
masterTimeout
@Deprecated @Nonnull public final CreateRepositoryRequest.Builder masterTimeout(@Nullable Time value) Deprecated.Explicit operation timeout for connection to cluster-manager nodeAPI name:
master_timeout -
masterTimeout
@Deprecated @Nonnull public final CreateRepositoryRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Deprecated.Explicit operation timeout for connection to cluster-manager nodeAPI name:
master_timeout -
name
Required - The name for the newly registered repository.API name:
repository -
repository
API name:repository -
repository
@Nonnull public final CreateRepositoryRequest.Builder repository(Function<Repository.Builder, ObjectBuilder<Repository>> fn) API name:repository -
settings
Required - API name:settings -
settings
@Nonnull public final CreateRepositoryRequest.Builder settings(Function<RepositorySettings.Builder, ObjectBuilder<RepositorySettings>> fn) Required - API name:settings -
timeout
The amount of time to wait for a response.API name:
timeout -
timeout
@Nonnull public final CreateRepositoryRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) The amount of time to wait for a response.API name:
timeout -
type
Required - API name:type -
verify
Whentrue, verifies the creation of the snapshot repository.API name:
verify -
build
Builds aCreateRepositoryRequest.- Specified by:
buildin interfaceObjectBuilder<CreateRepositoryRequest>- Throws:
NullPointerException- if some of the required fields are null.
-