Class GetTransformRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.transform.GetTransformRequest
public class GetTransformRequest extends RequestBase
Retrieves configuration information for transforms.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetTransformRequest.Builder
Builder forGetTransformRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetTransformRequest,GetTransformResponse,ErrorResponse>
_ENDPOINT
Endpoint "transform.get_transform
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoMatch()
Specifies what to do when the request: Contains wildcard expressions and there are no transforms that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.java.lang.Boolean
excludeGenerated()
Excludes fields that were automatically added when creating the transform.java.lang.Integer
from()
Skips the specified number of transforms.static GetTransformRequest
of(java.util.function.Function<GetTransformRequest.Builder,ObjectBuilder<GetTransformRequest>> fn)
java.lang.Integer
size()
Specifies the maximum number of transforms to obtain.java.lang.String
transformId()
Identifier for the transform.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "transform.get_transform
".
-
-
Method Details
-
of
public static GetTransformRequest of(java.util.function.Function<GetTransformRequest.Builder,ObjectBuilder<GetTransformRequest>> fn) -
allowNoMatch
@Nullable public final java.lang.Boolean allowNoMatch()Specifies what to do when the request:- Contains wildcard expressions and there are no transforms that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.
API name:
allow_no_match
-
excludeGenerated
@Nullable public final java.lang.Boolean excludeGenerated()Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.API name:
exclude_generated
-
from
@Nullable public final java.lang.Integer from()Skips the specified number of transforms.API name:
from
-
size
@Nullable public final java.lang.Integer size()Specifies the maximum number of transforms to obtain.API name:
size
-
transformId
@Nullable public final java.lang.String transformId()Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using_all
, by specifying*
as the<transform_id>
, or by omitting the<transform_id>
.API name:
transform_id
-