software.amazon.awssdk.services.securityhub.model

Class AwsApiGatewayRestApiDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsApiGatewayRestApiDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsApiGatewayRestApiDetails.Builder,AwsApiGatewayRestApiDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsApiGatewayRestApiDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsApiGatewayRestApiDetails.Builder,AwsApiGatewayRestApiDetails>

Contains information about a REST API in version 1 of Amazon API Gateway.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsApiGatewayRestApiDetails.Builder

Method Summary

Modifier and Type	Method and Description
String	apiKeySource() The source of the API key for metering requests according to a usage plan.
List<String>	binaryMediaTypes() The list of binary media types supported by the REST API.
static AwsApiGatewayRestApiDetails.Builder	builder()
String	createdDate() Indicates when the API was created.
String	description() A description of the REST API.
AwsApiGatewayEndpointConfiguration	endpointConfiguration() The endpoint configuration of the REST API.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBinaryMediaTypes() Returns true if the BinaryMediaTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	id() The identifier of the REST API.
Integer	minimumCompressionSize() The minimum size in bytes of a payload before compression is enabled.
String	name() The name of the REST API.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsApiGatewayRestApiDetails.Builder>	serializableBuilderClass()
AwsApiGatewayRestApiDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version identifier for the REST API.

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

id

public final String id()

The identifier of the REST API.

Returns:

The identifier of the REST API.

name

public final String name()

The name of the REST API.

Returns:

The name of the REST API.

description

public final String description()

A description of the REST API.

Returns:

A description of the REST API.

createdDate

public final String createdDate()

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

Indicates when the API was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

version

public final String version()

The version identifier for the REST API.

Returns:

The version identifier for the REST API.

hasBinaryMediaTypes

public final boolean hasBinaryMediaTypes()

Returns true if the BinaryMediaTypes 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.

binaryMediaTypes

public final List<String> binaryMediaTypes()

The list of binary media types supported by the REST API.

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

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

Returns:

The list of binary media types supported by the REST API.

minimumCompressionSize

public final Integer minimumCompressionSize()

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

Returns:

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

apiKeySource

public final String apiKeySource()

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

Returns:

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

endpointConfiguration

public final AwsApiGatewayEndpointConfiguration endpointConfiguration()

The endpoint configuration of the REST API.

Returns:

The endpoint configuration of the REST API.

toBuilder

public AwsApiGatewayRestApiDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsApiGatewayRestApiDetails.Builder,AwsApiGatewayRestApiDetails>

builder

public static AwsApiGatewayRestApiDetails.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo