co.elastic.clients.elasticsearch.transform.GetTransformRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.transform;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: transform.get_transform.Request
/**
* Get transforms. Retrieves configuration information for transforms.
*
* @see API
* specification
*/
public class GetTransformRequest extends RequestBase {
@Nullable
private final Boolean allowNoMatch;
@Nullable
private final Boolean excludeGenerated;
@Nullable
private final Integer from;
@Nullable
private final Integer size;
private final List transformId;
// ---------------------------------------------------------------------------------------------
private GetTransformRequest(Builder builder) {
this.allowNoMatch = builder.allowNoMatch;
this.excludeGenerated = builder.excludeGenerated;
this.from = builder.from;
this.size = builder.size;
this.transformId = ApiTypeHelper.unmodifiable(builder.transformId);
}
public static GetTransformRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* 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: {@code allow_no_match}
*/
@Nullable
public final Boolean allowNoMatch() {
return this.allowNoMatch;
}
/**
* 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: {@code exclude_generated}
*/
@Nullable
public final Boolean excludeGenerated() {
return this.excludeGenerated;
}
/**
* Skips the specified number of transforms.
*
* API name: {@code from}
*/
@Nullable
public final Integer from() {
return this.from;
}
/**
* Specifies the maximum number of transforms to obtain.
*
* API name: {@code size}
*/
@Nullable
public final Integer size() {
return this.size;
}
/**
* 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: {@code transform_id}
*/
public final List transformId() {
return this.transformId;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GetTransformRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean allowNoMatch;
@Nullable
private Boolean excludeGenerated;
@Nullable
private Integer from;
@Nullable
private Integer size;
@Nullable
private List transformId;
/**
* 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: {@code allow_no_match}
*/
public final Builder allowNoMatch(@Nullable Boolean value) {
this.allowNoMatch = value;
return this;
}
/**
* 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: {@code exclude_generated}
*/
public final Builder excludeGenerated(@Nullable Boolean value) {
this.excludeGenerated = value;
return this;
}
/**
* Skips the specified number of transforms.
*
* API name: {@code from}
*/
public final Builder from(@Nullable Integer value) {
this.from = value;
return this;
}
/**
* Specifies the maximum number of transforms to obtain.
*
* API name: {@code size}
*/
public final Builder size(@Nullable Integer value) {
this.size = value;
return this;
}
/**
* 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: {@code transform_id}
*
* Adds all elements of list to transformId.
*/
public final Builder transformId(List list) {
this.transformId = _listAddAll(this.transformId, list);
return this;
}
/**
* 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: {@code transform_id}
*
* Adds one or more values to transformId.
*/
public final Builder transformId(String value, String... values) {
this.transformId = _listAdd(this.transformId, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link GetTransformRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GetTransformRequest build() {
_checkSingleUse();
return new GetTransformRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code transform.get_transform}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/transform.get_transform",
// Request method
request -> {
return "GET";
},
// Request path
request -> {
final int _transformId = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.transformId()))
propsSet |= _transformId;
if (propsSet == (_transformId)) {
StringBuilder buf = new StringBuilder();
buf.append("/_transform");
buf.append("/");
SimpleEndpoint.pathEncode(request.transformId.stream().map(v -> v).collect(Collectors.joining(",")),
buf);
return buf.toString();
}
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_transform");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _transformId = 1 << 0;
int propsSet = 0;
if (ApiTypeHelper.isDefined(request.transformId()))
propsSet |= _transformId;
if (propsSet == (_transformId)) {
params.put("transformId",
request.transformId.stream().map(v -> v).collect(Collectors.joining(",")));
}
if (propsSet == 0) {
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.size != null) {
params.put("size", String.valueOf(request.size));
}
if (request.excludeGenerated != null) {
params.put("exclude_generated", String.valueOf(request.excludeGenerated));
}
if (request.from != null) {
params.put("from", String.valueOf(request.from));
}
if (request.allowNoMatch != null) {
params.put("allow_no_match", String.valueOf(request.allowNoMatch));
}
return params;
}, SimpleEndpoint.emptyMap(), false, GetTransformResponse._DESERIALIZER);
}