Class GetTemplateRequest.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetTemplateRequest.Builder>
org.opensearch.client.opensearch.indices.GetTemplateRequest.Builder
- All Implemented Interfaces:
CopyableBuilder<GetTemplateRequest.Builder,,GetTemplateRequest> MutableBuilder<GetTemplateRequest.Builder,,GetTemplateRequest> ObjectBuilder<GetTemplateRequest>
- Enclosing class:
GetTemplateRequest
public static class GetTemplateRequest.Builder
extends RequestBase.AbstractBuilder<GetTemplateRequest.Builder>
implements CopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>
Builder for
GetTemplateRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aGetTemplateRequest.Operation timeout for connection to cluster-manager node.clusterManagerTimeout(Time value) Operation timeout for connection to cluster-manager node.copy()Create a new builderCopyableBuilderthat is a copy of this one.flatSettings(Boolean value) Iftrue, returns settings in flat format.Iftrue, the request retrieves information from the local node only.Deprecated.masterTimeout(Time value) Deprecated.Comma-separated list of index template names used to limit the request.Comma-separated list of index template names used to limit the request.protected GetTemplateRequest.Builderself()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<GetTemplateRequest.Builder,GetTemplateRequest> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classRequestBase.AbstractBuilder<GetTemplateRequest.Builder>
-
clusterManagerTimeout
Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
clusterManagerTimeout
@Nonnull public final GetTemplateRequest.Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
flatSettings
Iftrue, returns settings in flat format.API name:
flat_settings -
local
Iftrue, the request retrieves information from the local node only.API name:
local -
masterTimeout
Deprecated.Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout -
masterTimeout
@Deprecated @Nonnull public final GetTemplateRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Deprecated.Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout -
name
Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of_allor*.API name:
nameAdds all elements of
listtoname. -
name
Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of_allor*.API name:
nameAdds one or more values to
name. -
build
Builds aGetTemplateRequest.- Specified by:
buildin interfaceObjectBuilder<GetTemplateRequest>- Throws:
NullPointerException- if some of the required fields are null.
-