Package org.opensearch.client.opensearch.security

Class GetAllCertificatesRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.security.GetAllCertificatesRequest

All Implemented Interfaces:

ToCopyableBuilder<GetAllCertificatesRequest.Builder,GetAllCertificatesRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class GetAllCertificatesRequest
extends RequestBase
implements ToCopyableBuilder<GetAllCertificatesRequest.Builder,GetAllCertificatesRequest>

Retrieves the cluster security certificates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetAllCertificatesRequest.Builder	Builder for GetAllCertificatesRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetAllCertificatesRequest,GetAllCertificatesResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_all_certificates".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static GetAllCertificatesRequest.Builder	builder()
final String	certType()	The type of certificates (HTTP, TRANSPORT, or ALL) to retrieve from all nodes.
boolean	equals(Object o)
int	hashCode()
static GetAllCertificatesRequest	of(Function<GetAllCertificatesRequest.Builder,ObjectBuilder<GetAllCertificatesRequest>> fn)
final Time	timeout()	The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout.
GetAllCertificatesRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<GetAllCertificatesRequest,GetAllCertificatesResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_all_certificates".

Method Details

of

public static GetAllCertificatesRequest of(Function<GetAllCertificatesRequest.Builder,ObjectBuilder<GetAllCertificatesRequest>> fn)

certType

@Nullable
public final String certType()

The type of certificates (HTTP, TRANSPORT, or ALL) to retrieve from all nodes.

API name: cert_type

timeout

@Nullable
public final Time timeout()

The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout.

API name: timeout

toBuilder

@Nonnull
public GetAllCertificatesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetAllCertificatesRequest.Builder,GetAllCertificatesRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GetAllCertificatesRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object