Interface OpenSearchAuthSchemeParams

All Superinterfaces:

ToCopyableBuilder<OpenSearchAuthSchemeParams.Builder,OpenSearchAuthSchemeParams>

All Known Implementing Classes:

DefaultOpenSearchAuthSchemeParams

@Generated("software.amazon.awssdk:codegen")
public interface OpenSearchAuthSchemeParams
extends ToCopyableBuilder<OpenSearchAuthSchemeParams.Builder,OpenSearchAuthSchemeParams>

The parameters object used to resolve the auth schemes for the OpenSearch service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OpenSearchAuthSchemeParams.Builder	A builder for a OpenSearchAuthSchemeParams.

Method Summary

Modifier and Type	Method	Description
static OpenSearchAuthSchemeParams.Builder	builder()	Get a new builder for creating a OpenSearchAuthSchemeParams.
String	operation()	Returns the operation for which to resolve the auth scheme.
Region	region()	Returns the region.
OpenSearchAuthSchemeParams.Builder	toBuilder()	Returns a OpenSearchAuthSchemeParams.Builder to customize the parameters.

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

builder

static OpenSearchAuthSchemeParams.Builder builder()

Get a new builder for creating a OpenSearchAuthSchemeParams.

operation

String operation()

Returns the operation for which to resolve the auth scheme.

region

Region region()

Returns the region. The region parameter may be used with the "aws.auth#sigv4" auth scheme.

toBuilder

OpenSearchAuthSchemeParams.Builder toBuilder()

Returns a OpenSearchAuthSchemeParams.Builder to customize the parameters.

Specified by:

toBuilder in interface ToCopyableBuilder<OpenSearchAuthSchemeParams.Builder,OpenSearchAuthSchemeParams>

Returns:

a builder for type T