software.amazon.awssdk.services.apigateway.model

Class GetClientCertificateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.core.AwsResponse

software.amazon.awssdk.services.apigateway.model.APIGatewayResponse

software.amazon.awssdk.services.apigateway.model.GetClientCertificateResponse

All Implemented Interfaces:

ToCopyableBuilder<GetClientCertificateResponse.Builder,GetClientCertificateResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class GetClientCertificateResponse
extends APIGatewayResponse
implements ToCopyableBuilder<GetClientCertificateResponse.Builder,GetClientCertificateResponse>

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.

Use Client-Side Certificate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetClientCertificateResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetClientCertificateResponse.Builder	builder()
String	clientCertificateId() The identifier of the client certificate.
Instant	createdDate() The timestamp when the client certificate was created.
String	description() The description of the client certificate.
boolean	equals(Object obj)
Instant	expirationDate() The timestamp when the client certificate will expire.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	pemEncodedCertificate() The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
static Class<? extends GetClientCertificateResponse.Builder>	serializableBuilderClass()
GetClientCertificateResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clientCertificateId

public String clientCertificateId()

The identifier of the client certificate.

Returns:

The identifier of the client certificate.

description

public String description()

The description of the client certificate.

Returns:

The description of the client certificate.

pemEncodedCertificate

public String pemEncodedCertificate()

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Returns:

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

createdDate

public Instant createdDate()

The timestamp when the client certificate was created.

Returns:

The timestamp when the client certificate was created.

expirationDate

public Instant expirationDate()

The timestamp when the client certificate will expire.

Returns:

The timestamp when the client certificate will expire.

toBuilder

public GetClientCertificateResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetClientCertificateResponse.Builder,GetClientCertificateResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetClientCertificateResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetClientCertificateResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value