Package co.elastic.clients.elasticsearch.snapshot

Class SourceOnlyRepositorySettingsForAzure.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SourceOnlyRepositorySettingsForAzure.Builder>

co.elastic.clients.elasticsearch.snapshot.SourceOnlyRepositorySettingsForAzure.Builder

All Implemented Interfaces:

WithJson<SourceOnlyRepositorySettingsForAzure.Builder>, ObjectBuilder<SourceOnlyRepositorySettingsForAzure>

Enclosing class:

SourceOnlyRepositorySettingsForAzure

public static class SourceOnlyRepositorySettingsForAzure.Builder
extends WithJsonObjectBuilderBase<SourceOnlyRepositorySettingsForAzure.Builder>
implements ObjectBuilder<SourceOnlyRepositorySettingsForAzure>

Builder for SourceOnlyRepositorySettingsForAzure.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SourceOnlyRepositorySettingsForAzure.Builder	basePath(String value)	The path to the repository data within the container.
SourceOnlyRepositorySettingsForAzure	build()	Builds a SourceOnlyRepositorySettingsForAzure.
final SourceOnlyRepositorySettingsForAzure.Builder	client(String value)	The name of the Azure repository client to use.
final SourceOnlyRepositorySettingsForAzure.Builder	container(String value)	The Azure container.
final SourceOnlyRepositorySettingsForAzure.Builder	deleteObjectsMaxSize(Integer value)	The maxmimum batch size, between 1 and 256, used for BlobBatch requests.
final SourceOnlyRepositorySettingsForAzure.Builder	locationMode(String value)	Either primary_only or secondary_only.
final SourceOnlyRepositorySettingsForAzure.Builder	maxConcurrentBatchDeletes(Integer value)	The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with BlobBatch.
final SourceOnlyRepositorySettingsForAzure.Builder	readonly(Boolean value)	If true, the repository is read-only.
protected SourceOnlyRepositorySettingsForAzure.Builder	self()

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

basePath

public final SourceOnlyRepositorySettingsForAzure.Builder basePath(@Nullable
 String value)

The path to the repository data within the container. It defaults to the root directory.

NOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise. Elastic Cloud Enterprise automatically generates the base_path for each deployment so that multiple deployments can share the same bucket.

API name: base_path

client

public final SourceOnlyRepositorySettingsForAzure.Builder client(@Nullable
 String value)

The name of the Azure repository client to use.

API name: client

container

public final SourceOnlyRepositorySettingsForAzure.Builder container(@Nullable
 String value)

The Azure container.

API name: container

deleteObjectsMaxSize

public final SourceOnlyRepositorySettingsForAzure.Builder deleteObjectsMaxSize(@Nullable
 Integer value)

The maxmimum batch size, between 1 and 256, used for BlobBatch requests. Defaults to 256 which is the maximum number supported by the Azure blob batch API.

API name: delete_objects_max_size

locationMode

public final SourceOnlyRepositorySettingsForAzure.Builder locationMode(@Nullable
 String value)

Either primary_only or secondary_only. Note that if you set it to secondary_only, it will force readonly to true.

API name: location_mode

maxConcurrentBatchDeletes

public final SourceOnlyRepositorySettingsForAzure.Builder maxConcurrentBatchDeletes(@Nullable
 Integer value)

The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with BlobBatch. Note that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits. Defaults to 10, minimum is 1, maximum is 100.

API name: max_concurrent_batch_deletes

readonly

public final SourceOnlyRepositorySettingsForAzure.Builder readonly(@Nullable
 Boolean value)

If true, the repository is read-only. The cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.

Only a cluster with write access can create snapshots in the repository. All other clusters connected to the repository should have the readonly parameter set to true. If false, the cluster can write to the repository and create snapshots in it.

IMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository. Having multiple clusters write to the repository at the same time risks corrupting the contents of the repository.

API name: readonly

self

protected SourceOnlyRepositorySettingsForAzure.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SourceOnlyRepositorySettingsForAzure.Builder>

build

public SourceOnlyRepositorySettingsForAzure build()

Builds a SourceOnlyRepositorySettingsForAzure.

Specified by:

build in interface ObjectBuilder<SourceOnlyRepositorySettingsForAzure>

Throws:

NullPointerException - if some of the required fields are null.