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

Class PutRepositoryRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

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

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

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

All Implemented Interfaces:

AckedRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class PutRepositoryRequest
extends AcknowledgedRequest<PutRepositoryRequest>

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

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 class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	name() The name of the repository.
PutRepositoryRequest	name(String name) Sets the name of the repository.
void	readFrom(StreamInput in)
Settings	settings() Returns repository settings
PutRepositoryRequest	settings(Map<String,Object> source) Sets the repository settings.
PutRepositoryRequest	settings(Settings.Builder settings) Sets the repository settings
PutRepositoryRequest	settings(Settings settings) Sets the repository settings
PutRepositoryRequest	settings(String source) Sets the repository settings.
PutRepositoryRequest	source(byte[] repositoryDefinition) Parses repository definition.
PutRepositoryRequest	source(byte[] repositoryDefinition, int offset, int length) Parses repository definition.
PutRepositoryRequest	source(BytesReference repositoryDefinition) Parses repository definition.
PutRepositoryRequest	source(Map repositoryDefinition) Parses repository definition.
PutRepositoryRequest	source(String repositoryDefinition) Parses repository definition.
PutRepositoryRequest	source(XContentBuilder repositoryDefinition) Parses repository definition.
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)

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

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

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

masterNodeTimeout

Constructor Detail

PutRepositoryRequest

public PutRepositoryRequest()

PutRepositoryRequest

public PutRepositoryRequest(String name)

Constructs a new put repository request with the provided name.

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<PutRepositoryRequest>

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)

Sets the repository settings.

Parameters:

source - repository settings in json, yaml or properties format

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(XContentBuilder repositoryDefinition)

Parses repository definition.

Parameters:

repositoryDefinition - repository definition

source

public PutRepositoryRequest source(Map repositoryDefinition)

Parses repository definition.

Parameters:

repositoryDefinition - repository definition

source

public PutRepositoryRequest source(String repositoryDefinition)

Parses repository definition. JSON, Smile and YAML formats are supported

Parameters:

repositoryDefinition - repository definition

source

public PutRepositoryRequest source(byte[] repositoryDefinition)

Parses repository definition. JSON, Smile and YAML formats are supported

Parameters:

repositoryDefinition - repository definition

source

public PutRepositoryRequest source(byte[] repositoryDefinition,
                          int offset,
                          int length)

Parses repository definition. JSON, Smile and YAML formats are supported

Parameters:

repositoryDefinition - repository definition

source

public PutRepositoryRequest source(BytesReference repositoryDefinition)

Parses repository definition. JSON, Smile and YAML formats are supported

Parameters:

repositoryDefinition - repository definition

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<PutRepositoryRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<PutRepositoryRequest>

Throws:

IOException