Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.repositories.put

Class PutRepositoryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<PutRepositoryRequest>

org.elasticsearch.action.admin.cluster.repositories.put.PutRepositoryRequest

All Implemented Interfaces:

AckedRequest, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

public class PutRepositoryRequest
extends AcknowledgedRequest<PutRepositoryRequest>
implements ToXContentObject

Register repository request.

Registers a repository with given name, type and settings. If the repository with the same name already exists in the cluster, the new repository will replace the existing repository.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PutRepositoryRequest()
PutRepositoryRequest(String name)	Constructs a new put repository request with the provided name.
PutRepositoryRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	name()	The name of the repository.
PutRepositoryRequest	name(String name)	Sets the name of the repository.
Settings	settings()	Returns repository settings
PutRepositoryRequest	settings(String source, XContentType xContentType)	Sets the repository settings.
PutRepositoryRequest	settings(Map<String,Object> source)	Sets the repository settings.
PutRepositoryRequest	settings(Settings settings)	Sets the repository settings
PutRepositoryRequest	settings(Settings.Builder settings)	Sets the repository settings
PutRepositoryRequest	source(Map<String,Object> repositoryDefinition)	Parses repository definition.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	type()	Returns repository type
PutRepositoryRequest	type(String type)	The type of the repository "fs" - shared filesystem repository
ActionRequestValidationException	validate()
boolean	verify()	Returns true if repository should be verified after creation
PutRepositoryRequest	verify(boolean verify)	Sets whether or not the repository should be verified after creation
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, timeout, timeout, timeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

PutRepositoryRequest

public PutRepositoryRequest(StreamInput in)
                     throws IOException

Throws:

IOException

PutRepositoryRequest

public PutRepositoryRequest()

PutRepositoryRequest

public PutRepositoryRequest(String name)

Constructs a new put repository request with the provided name.

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

name

public PutRepositoryRequest name(String name)

Sets the name of the repository.

Parameters:

name - repository name

name

public String name()

The name of the repository.

Returns:

repository name

type

public PutRepositoryRequest type(String type)

The type of the repository

• "fs" - shared filesystem repository

Parameters:

type - repository type

Returns:

this request

type

public String type()

Returns repository type

Returns:

repository type

settings

public PutRepositoryRequest settings(Settings settings)

Sets the repository settings

Parameters:

settings - repository settings

Returns:

this request

settings

public PutRepositoryRequest settings(Settings.Builder settings)

Sets the repository settings

Parameters:

settings - repository settings

Returns:

this request

settings

public PutRepositoryRequest settings(String source,
 XContentType xContentType)

Sets the repository settings.

Parameters:

source - repository settings in json or yaml format

xContentType - the content type of the source

Returns:

this request

settings

public PutRepositoryRequest settings(Map<String,Object> source)

Sets the repository settings.

Parameters:

source - repository settings

Returns:

this request

settings

public Settings settings()

Returns repository settings

Returns:

repository settings

verify

public PutRepositoryRequest verify(boolean verify)

Sets whether or not the repository should be verified after creation

verify

public boolean verify()

Returns true if repository should be verified after creation

source

public PutRepositoryRequest source(Map<String,Object> repositoryDefinition)

Parses repository definition.

Parameters:

repositoryDefinition - repository definition

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<PutRepositoryRequest>

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException