Package co.elastic.clients.elasticsearch.snapshot

Class RepositoryVerifyIntegrityRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<RepositoryVerifyIntegrityRequest.Builder>

co.elastic.clients.elasticsearch.snapshot.RepositoryVerifyIntegrityRequest.Builder

All Implemented Interfaces:

WithJson<RepositoryVerifyIntegrityRequest.Builder>, ObjectBuilder<RepositoryVerifyIntegrityRequest>

Enclosing class:

RepositoryVerifyIntegrityRequest

public static class RepositoryVerifyIntegrityRequest.Builder
extends RequestBase.AbstractBuilder<RepositoryVerifyIntegrityRequest.Builder>
implements ObjectBuilder<RepositoryVerifyIntegrityRequest>

Builder for RepositoryVerifyIntegrityRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RepositoryVerifyIntegrityRequest.Builder	blobThreadPoolConcurrency(Integer value)	If verify_blob_contents is true, this parameter specifies how many blobs to verify at once.
RepositoryVerifyIntegrityRequest	build()	Builds a RepositoryVerifyIntegrityRequest.
final RepositoryVerifyIntegrityRequest.Builder	indexSnapshotVerificationConcurrency(Integer value)	The maximum number of index snapshots to verify concurrently within each index verification.
final RepositoryVerifyIntegrityRequest.Builder	indexVerificationConcurrency(Integer value)	The number of indices to verify concurrently.
final RepositoryVerifyIntegrityRequest.Builder	maxBytesPerSec(String value)	If verify_blob_contents is true, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.
final RepositoryVerifyIntegrityRequest.Builder	maxFailedShardSnapshots(Integer value)	The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage.
final RepositoryVerifyIntegrityRequest.Builder	metaThreadPoolConcurrency(Integer value)	The maximum number of snapshot metadata operations to run concurrently.
final RepositoryVerifyIntegrityRequest.Builder	name(String value, String... values)	Required - The name of the snapshot repository.
final RepositoryVerifyIntegrityRequest.Builder	name(List<String> list)	Required - The name of the snapshot repository.
protected RepositoryVerifyIntegrityRequest.Builder	self()
final RepositoryVerifyIntegrityRequest.Builder	snapshotVerificationConcurrency(Integer value)	The number of snapshots to verify concurrently.
final RepositoryVerifyIntegrityRequest.Builder	verifyBlobContents(Boolean value)	Indicates whether to verify the checksum of every data blob in the repository.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

blobThreadPoolConcurrency

public final RepositoryVerifyIntegrityRequest.Builder blobThreadPoolConcurrency(@Nullable
 Integer value)

If verify_blob_contents is true, this parameter specifies how many blobs to verify at once.

API name: blob_thread_pool_concurrency

indexSnapshotVerificationConcurrency

public final RepositoryVerifyIntegrityRequest.Builder indexSnapshotVerificationConcurrency(@Nullable
 Integer value)

The maximum number of index snapshots to verify concurrently within each index verification.

API name: index_snapshot_verification_concurrency

indexVerificationConcurrency

public final RepositoryVerifyIntegrityRequest.Builder indexVerificationConcurrency(@Nullable
 Integer value)

The number of indices to verify concurrently. The default behavior is to use the entire snapshot_meta thread pool.

API name: index_verification_concurrency

maxBytesPerSec

public final RepositoryVerifyIntegrityRequest.Builder maxBytesPerSec(@Nullable
 String value)

If verify_blob_contents is true, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.

API name: max_bytes_per_sec

maxFailedShardSnapshots

public final RepositoryVerifyIntegrityRequest.Builder maxFailedShardSnapshots(@Nullable
 Integer value)

The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage. If your repository contains more than this number of shard snapshot failures, the verification will fail.

API name: max_failed_shard_snapshots

metaThreadPoolConcurrency

public final RepositoryVerifyIntegrityRequest.Builder metaThreadPoolConcurrency(@Nullable
 Integer value)

The maximum number of snapshot metadata operations to run concurrently. The default behavior is to use at most half of the snapshot_meta thread pool at once.

API name: meta_thread_pool_concurrency

name

public final RepositoryVerifyIntegrityRequest.Builder name(List<String> list)

Required - The name of the snapshot repository.

API name: repository

Adds all elements of list to name.

name

public final RepositoryVerifyIntegrityRequest.Builder name(String value,
 String... values)

Required - The name of the snapshot repository.

API name: repository

Adds one or more values to name.

snapshotVerificationConcurrency

public final RepositoryVerifyIntegrityRequest.Builder snapshotVerificationConcurrency(@Nullable
 Integer value)

The number of snapshots to verify concurrently. The default behavior is to use at most half of the snapshot_meta thread pool at once.

API name: snapshot_verification_concurrency

verifyBlobContents

public final RepositoryVerifyIntegrityRequest.Builder verifyBlobContents(@Nullable
 Boolean value)

Indicates whether to verify the checksum of every data blob in the repository. If this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.

API name: verify_blob_contents

self

protected RepositoryVerifyIntegrityRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RepositoryVerifyIntegrityRequest.Builder>

build

public RepositoryVerifyIntegrityRequest build()

Builds a RepositoryVerifyIntegrityRequest.

Specified by:

build in interface ObjectBuilder<RepositoryVerifyIntegrityRequest>

Throws:

NullPointerException - if some of the required fields are null.