Class S3RepositorySettingsDescriptor
Inheritance
S3RepositorySettingsDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class S3RepositorySettingsDescriptor : DescriptorBase<S3RepositorySettingsDescriptor, IS3RepositorySettings>, IDescriptor, IS3RepositorySettings, IRepositorySettings
Constructors
|
Edit this page
View Source
S3RepositorySettingsDescriptor(string)
Declaration
public S3RepositorySettingsDescriptor(string bucket)
Parameters
| Type |
Name |
Description |
| string |
bucket |
|
Methods
|
Edit this page
View Source
BasePath(string)
Specifies the path within bucket to repository data.
Defaults to value of repositories.s3.base_path or to root directory if not set.
Declaration
public S3RepositorySettingsDescriptor BasePath(string basePath)
Parameters
| Type |
Name |
Description |
| string |
basePath |
|
Returns
|
Edit this page
View Source
Bucket(string)
The name of the bucket to be used for snapshots. This field is required
Declaration
public S3RepositorySettingsDescriptor Bucket(string bucket)
Parameters
| Type |
Name |
Description |
| string |
bucket |
|
Returns
|
Edit this page
View Source
BufferSize(string)
Minimum threshold below which the chunk is uploaded using a single request.
Beyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into
several parts, each of buffer_size length, and to upload each part in its own request. Note that setting a
buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result
in upload errors. It is also not possible to set a buffer size greater than 5gb as it is the maximum upload
size allowed by S3. Defaults to the minimum between 100mb and 5% of the heap size.
Declaration
public S3RepositorySettingsDescriptor BufferSize(string bufferSize)
Parameters
| Type |
Name |
Description |
| string |
bufferSize |
|
Returns
|
Edit this page
View Source
CannedAcl(string)
Specify a canned ACL for the S3 bucket.
The S3 repository supports all S3 canned ACLs : private, public-read, public-read-write, authenticated-read,
log-delivery-write, bucket-owner-read, bucket-owner-full-control. Defaults to private.
Declaration
public S3RepositorySettingsDescriptor CannedAcl(string cannedAcl)
Parameters
| Type |
Name |
Description |
| string |
cannedAcl |
|
Returns
|
Edit this page
View Source
ChunkSize(string)
Big files can be broken down into chunks during snapshotting if needed.
The chunk size can be specified in bytes or by using size value notation,
i.e. 1gb, 10mb, 5kb. Defaults to 1gb.
Declaration
public S3RepositorySettingsDescriptor ChunkSize(string chunkSize)
Parameters
| Type |
Name |
Description |
| string |
chunkSize |
|
Returns
|
Edit this page
View Source
Client(string)
The name of the s3 client to use to connect to S3. Defaults to default.
Declaration
public S3RepositorySettingsDescriptor Client(string client)
Parameters
| Type |
Name |
Description |
| string |
client |
|
Returns
|
Edit this page
View Source
Compress(bool?)
When set to true metadata files are stored in compressed format.
This setting doesn't affect index files that are already compressed by default.
Defaults to false.
Declaration
public S3RepositorySettingsDescriptor Compress(bool? compress = true)
Parameters
| Type |
Name |
Description |
| bool? |
compress |
|
Returns
|
Edit this page
View Source
DisableChunkedEncoding(bool?)
Whether chunked encoding should be disabled or not. If false, chunked encoding is enabled and will be used where appropriate.
If true, chunked encoding is disabled and will not be used, which may mean that snapshot operations consume more resources
and take longer to complete. It should only be set to true if you are using a storage service that does not support chunked
encoding. Defaults to false.
Declaration
public S3RepositorySettingsDescriptor DisableChunkedEncoding(bool? disableChunkedEncoding = true)
Parameters
| Type |
Name |
Description |
| bool? |
disableChunkedEncoding |
|
Returns
|
Edit this page
View Source
MaxRestoreBytesPerSecond(string)
Throttles per node restore rate. Defaults to 40mb per second.
Declaration
public S3RepositorySettingsDescriptor MaxRestoreBytesPerSecond(string maxRestoreBytesPerSecond)
Parameters
| Type |
Name |
Description |
| string |
maxRestoreBytesPerSecond |
|
Returns
|
Edit this page
View Source
MaxSnapshotBytesPerSecond(string)
Throttles per node snapshot rate. Defaults to 40mb per second.
Declaration
public S3RepositorySettingsDescriptor MaxSnapshotBytesPerSecond(string maxSnapshotBytesPerSecond)
Parameters
| Type |
Name |
Description |
| string |
maxSnapshotBytesPerSecond |
|
Returns
|
Edit this page
View Source
PathStyleAccess(bool?)
Whether to force the use of the path style access pattern. If true, the
path style access pattern will be used. If false, the access pattern will
be automatically determined by the AWS Java SDK used internally by OpenSearch
Declaration
public S3RepositorySettingsDescriptor PathStyleAccess(bool? pathStyleAccess = true)
Parameters
| Type |
Name |
Description |
| bool? |
pathStyleAccess |
|
Returns
|
Edit this page
View Source
ReadOnly(bool?)
Make the repository readonly. Defaults to false.
Declaration
public S3RepositorySettingsDescriptor ReadOnly(bool? readOnly = true)
Parameters
| Type |
Name |
Description |
| bool? |
readOnly |
|
Returns
|
Edit this page
View Source
ServerSideEncryption(bool?)
When set to true files are encrypted on server side using AES256 algorithm.
Defaults to false.
Declaration
public S3RepositorySettingsDescriptor ServerSideEncryption(bool? serverSideEncryption = true)
Parameters
| Type |
Name |
Description |
| bool? |
serverSideEncryption |
|
Returns
|
Edit this page
View Source
StorageClass(string)
Sets the S3 storage class type for the backup files. Values may be standard, reduced_redundancy, standard_ia.
Defaults to standard.
Declaration
public S3RepositorySettingsDescriptor StorageClass(string storageClass)
Parameters
| Type |
Name |
Description |
| string |
storageClass |
|
Returns
Implements
Extension Methods