Package software.amazon.awssdk.services.apigateway.model

Class ApiStage

java.lang.Object

software.amazon.awssdk.services.apigateway.model.ApiStage

All Implemented Interfaces:

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

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

API stage name of the associated API stage in a usage plan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApiStage.Builder

Method Summary

Modifier and Type	Method	Description
String	apiId()	API Id of the associated API stage in a usage plan.
static ApiStage.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasThrottle()	For responses, this returns true if the service returned a value for the Throttle property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ApiStage.Builder>	serializableBuilderClass()
String	stage()	API stage name of the associated API stage in a usage plan.
Map<String,ThrottleSettings>	throttle()	Map containing method level throttling information for API stage in a usage plan.
ApiStage.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

apiId

public final String apiId()

API Id of the associated API stage in a usage plan.

Returns:

API Id of the associated API stage in a usage plan.

stage

public final String stage()

API stage name of the associated API stage in a usage plan.

Returns:

API stage name of the associated API stage in a usage plan.

hasThrottle

public final boolean hasThrottle()

For responses, this returns true if the service returned a value for the Throttle property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

throttle

public final Map<String,ThrottleSettings> throttle()

Map containing method level throttling information for API stage in a usage plan.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasThrottle() method.

Returns:

Map containing method level throttling information for API stage in a usage plan.

toBuilder

public ApiStage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApiStage.Builder,ApiStage>

builder

public static ApiStage.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo