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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
apiId()
API Id of the associated API stage in a usage plan.static ApiStage.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Throttle property.static Class
<? extends ApiStage.Builder> final String
stage()
API stage name of the associated API stage in a usage plan.final Map
<String, ThrottleSettings> throttle()
Map containing method level throttling information for API stage in a usage plan.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<ApiStage.Builder,
ApiStage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-