Class GetIndexTemplateRequest
java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.GetIndexTemplateRequest
- All Implemented Interfaces:
ToCopyableBuilder<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetIndexTemplateRequest
extends RequestBase
implements ToCopyableBuilder<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest>
Returns an index template.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Endpoint<GetIndexTemplateRequest, GetIndexTemplateResponse, ErrorResponse> Endpoint "indices.get_index_template". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) builder()final TimeOperation timeout for connection to cluster-manager node.booleanfinal BooleanIftrue, returns settings in flat format.inthashCode()final Booleanlocal()Iftrue, the request retrieves information from the local node only.final TimeDeprecated.final Stringname()Name of the index template to retrieve.static GetIndexTemplateRequestCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetIndexTemplateRequest,GetIndexTemplateResponse, _ENDPOINTErrorResponse> Endpoint "indices.get_index_template".
-
-
Method Details
-
of
public static GetIndexTemplateRequest of(Function<GetIndexTemplateRequest.Builder, ObjectBuilder<GetIndexTemplateRequest>> fn) -
clusterManagerTimeout
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. Defaults to false, which means information is retrieved from the cluster-manager node.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 -
name
Name of the index template to retrieve. Wildcard (*) expressions are supported.API name:
name -
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest> - Returns:
- a new builder instance.
-
builder
-
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-