software.amazon.awssdk.services.apigatewayv2.model

Class RouteSettings

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.model.RouteSettings

All Implemented Interfaces:

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

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

Represents a collection of route settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RouteSettings.Builder

Method Summary

Modifier and Type	Method and Description
static RouteSettings.Builder	builder()
Boolean	dataTraceEnabled() Specifies whether (true) or not (false) data trace logging is enabled for this route.
Boolean	detailedMetricsEnabled() Specifies whether detailed metrics are enabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LoggingLevel	loggingLevel() Specifies the logging level for this route: INFO, ERROR, or OFF.
String	loggingLevelAsString() Specifies the logging level for this route: INFO, ERROR, or OFF.
List<SdkField<?>>	sdkFields()
static Class<? extends RouteSettings.Builder>	serializableBuilderClass()
Integer	throttlingBurstLimit() Specifies the throttling burst limit.
Double	throttlingRateLimit() Specifies the throttling rate limit.
RouteSettings.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

dataTraceEnabled

public final Boolean dataTraceEnabled()

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

Returns:

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

detailedMetricsEnabled

public final Boolean detailedMetricsEnabled()

Specifies whether detailed metrics are enabled.

Returns:

Specifies whether detailed metrics are enabled.

loggingLevel

public final LoggingLevel loggingLevel()

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

If the service returns an enum value that is not available in the current SDK version, loggingLevel will return LoggingLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from loggingLevelAsString().

Returns:

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

See Also:

LoggingLevel

loggingLevelAsString

public final String loggingLevelAsString()

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

If the service returns an enum value that is not available in the current SDK version, loggingLevel will return LoggingLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from loggingLevelAsString().

Returns:

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

See Also:

LoggingLevel

throttlingBurstLimit

public final Integer throttlingBurstLimit()

Specifies the throttling burst limit.

Returns:

Specifies the throttling burst limit.

throttlingRateLimit

public final Double throttlingRateLimit()

Specifies the throttling rate limit.

Returns:

Specifies the throttling rate limit.

toBuilder

public RouteSettings.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<RouteSettings.Builder,RouteSettings>

Returns:

a builder for type T

builder

public static RouteSettings.Builder builder()

serializableBuilderClass

public static Class<? extends RouteSettings.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.