Package org.opensearch.client.opensearch.snapshot

Class CreateRepositoryRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.snapshot.CreateRepositoryRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CreateRepositoryRequest.Builder,CreateRepositoryRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class CreateRepositoryRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<CreateRepositoryRequest.Builder,CreateRepositoryRequest>

Creates a snapshot repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateRepositoryRequest.Builder	Builder for CreateRepositoryRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CreateRepositoryRequest>	_DESERIALIZER	Json deserializer for CreateRepositoryRequest
static final Endpoint<CreateRepositoryRequest,CreateRepositoryResponse,ErrorResponse>	_ENDPOINT	Endpoint "snapshot.create_repository".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static CreateRepositoryRequest.Builder	builder()
final Time	clusterManagerTimeout()	The amount of time to wait for a response from the cluster manager node.
boolean	equals(Object o)
int	hashCode()
final Time	masterTimeout()	Deprecated.
final String	name()	Required - The name for the newly registered repository.
static CreateRepositoryRequest	of(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)
final Repository	repository()	API name: repository
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final RepositorySettings	settings()	Required - API name: settings
protected static void	setupCreateRepositoryRequestDeserializer(ObjectDeserializer<CreateRepositoryRequest.Builder> op)
final Time	timeout()	The amount of time to wait for a response.
CreateRepositoryRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	Required - API name: type
final Boolean	verify()	When true, verifies the creation of the snapshot repository.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CreateRepositoryRequest> _DESERIALIZER

Json deserializer for CreateRepositoryRequest

_ENDPOINT

public static final Endpoint<CreateRepositoryRequest,CreateRepositoryResponse,ErrorResponse> _ENDPOINT

Endpoint "snapshot.create_repository".

Method Details

of

public static CreateRepositoryRequest of(Function<CreateRepositoryRequest.Builder,ObjectBuilder<CreateRepositoryRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time 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

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Explicit operation timeout for connection to cluster-manager node

API name: master_timeout

name

@Nonnull
public final String name()

Required - The name for the newly registered repository.

API name: repository

repository

@Nullable
public final Repository repository()

API name: repository

settings

@Nonnull
public final RepositorySettings settings()

Required - API name: settings

timeout

@Nullable
public final Time timeout()

The amount of time to wait for a response.

API name: timeout

type

@Nonnull
public final String type()

Required - API name: type

verify

@Nullable
public final Boolean verify()

When true, verifies the creation of the snapshot repository.

API name: verify

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public CreateRepositoryRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRepositoryRequest.Builder,CreateRepositoryRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static CreateRepositoryRequest.Builder builder()

setupCreateRepositoryRequestDeserializer

protected static void setupCreateRepositoryRequestDeserializer(ObjectDeserializer<CreateRepositoryRequest.Builder> op)

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object