software.amazon.awssdk.services.apigateway.model

Class GetClientCertificateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetClientCertificateResponse.Builder,GetClientCertificateResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj)
Instant	expirationDate() The timestamp when the client certificate will expire.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	pemEncodedCertificate() The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
List<SdkField<?>>	sdkFields()
static Class<? extends GetClientCertificateResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags() The collection of tags.
GetClientCertificateResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

clientCertificateId

public final String clientCertificateId()

The identifier of the client certificate.

Returns:

The identifier of the client certificate.

description

public final String description()

The description of the client certificate.

Returns:

The description of the client certificate.

pemEncodedCertificate

public final 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 final Instant createdDate()

The timestamp when the client certificate was created.

Returns:

The timestamp when the client certificate was created.

expirationDate

public final Instant expirationDate()

The timestamp when the client certificate will expire.

Returns:

The timestamp when the client certificate will expire.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

The collection of tags. Each tag element is associated with a given resource.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The collection of tags. Each tag element is associated with a given resource.

toBuilder

public GetClientCertificateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetClientCertificateResponse.Builder,GetClientCertificateResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetClientCertificateResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo