Class PutRepositoryRequest
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
,org.elasticsearch.core.RefCounted
,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
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionname)
Constructs a new put repository request with the provided name. -
Method Summary
Modifier and TypeMethodDescriptionname()
The name of the repository.name)
Sets the name of the repository.settings()
Returns repository settingssource, org.elasticsearch.common.xcontent.XContentType xContentType)
Sets the repository settings.<,> source)
Sets the repository settings.Sets the repository settingssettings(Settings.Builder settings)
Sets the repository settings<,> repositoryDefinition)
Parses repository definition.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
type()
Returns repository typetype)
The type of the repository "fs" - shared filesystem repositoryvalidate()
boolean
verify()
Returns true if repository should be verified after creationverify(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.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.
, , , , , , , , ,
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.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
PutRepositoryRequest
- Throws:
-
PutRepositoryRequest
public PutRepositoryRequest() -
PutRepositoryRequest
public PutRepositoryRequest( name)Constructs a new put repository request with the provided name.
-
-
Method Details
-
validate
- Specified by:
validate
in classActionRequest
-
name
public name)Sets the name of the repository.- Parameters:
name
- repository name
-
name
public name()The name of the repository.- Returns:
- repository name
-
type
public type)The type of the repository- "fs" - shared filesystem repository
- Parameters:
type
- repository type- Returns:
- this request
-
type
public 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 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
public <,> source)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 <,> 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:
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-