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
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,TaskAwareRequest
public class PutRepositoryRequest extends AcknowledgedRequest<PutRepositoryRequest> implements org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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
-
Constructor Summary
Constructors Constructor Description PutRepositoryRequest()
PutRepositoryRequest(java.lang.String name)
Constructs a new put repository request with the provided name.PutRepositoryRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String
name()
The name of the repository.PutRepositoryRequest
name(java.lang.String name)
Sets the name of the repository.Settings
settings()
Returns repository settingsPutRepositoryRequest
settings(java.lang.String source, org.elasticsearch.common.xcontent.XContentType xContentType)
Sets the repository settings.PutRepositoryRequest
settings(java.util.Map<java.lang.String,java.lang.Object> source)
Sets the repository settings.PutRepositoryRequest
settings(Settings settings)
Sets the repository settingsPutRepositoryRequest
settings(Settings.Builder settings)
Sets the repository settingsPutRepositoryRequest
source(java.util.Map<java.lang.String,java.lang.Object> repositoryDefinition)
Parses repository definition.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
java.lang.String
type()
Returns repository typePutRepositoryRequest
type(java.lang.String type)
The type of the repository "fs" - shared filesystem repositoryActionRequestValidationException
validate()
boolean
verify()
Returns true if repository should be verified after creationPutRepositoryRequest
verify(boolean verify)
Sets whether or not the repository should be verified after creationvoid
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.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
PutRepositoryRequest
- Throws:
java.io.IOException
-
PutRepositoryRequest
public PutRepositoryRequest() -
PutRepositoryRequest
public PutRepositoryRequest(java.lang.String name)Constructs a new put repository request with the provided name.
-
-
Method Details
-
validate
- Specified by:
validate
in classActionRequest
-
name
Sets the name of the repository.- Parameters:
name
- repository name
-
name
public java.lang.String name()The name of the repository.- Returns:
- repository name
-
type
The type of the repository- "fs" - shared filesystem repository
- Parameters:
type
- repository type- Returns:
- this request
-
type
public java.lang.String type()Returns repository type- Returns:
- repository type
-
settings
Sets the repository settings- Parameters:
settings
- repository settings- Returns:
- this request
-
settings
Sets the repository settings- Parameters:
settings
- repository settings- Returns:
- this request
-
settings
public PutRepositoryRequest settings(java.lang.String source, org.elasticsearch.common.xcontent.XContentType xContentType)Sets the repository settings.- Parameters:
source
- repository settings in json or yaml formatxContentType
- the content type of the source- Returns:
- this request
-
settings
Sets the repository settings.- Parameters:
source
- repository settings- Returns:
- this request
-
settings
Returns repository settings- Returns:
- repository settings
-
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(java.util.Map<java.lang.String,java.lang.Object> repositoryDefinition)Parses repository definition.- Parameters:
repositoryDefinition
- repository definition
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classAcknowledgedRequest<PutRepositoryRequest>
- Throws:
java.io.IOException
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-