Package software.amazon.awssdk.services.apigatewayv2.model

Class CreateRoutingRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request

software.amazon.awssdk.services.apigatewayv2.model.CreateRoutingRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRoutingRuleRequest.Builder,CreateRoutingRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateRoutingRuleRequest
extends ApiGatewayV2Request
implements ToCopyableBuilder<CreateRoutingRuleRequest.Builder,CreateRoutingRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRoutingRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<RoutingRuleAction>	actions()	Represents a routing rule action.
static CreateRoutingRuleRequest.Builder	builder()
List<RoutingRuleCondition>	conditions()	Represents a condition.
String	domainName()	The domain name.
String	domainNameId()	The domain name ID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions()	For responses, this returns true if the service returned a value for the Actions property.
boolean	hasConditions()	For responses, this returns true if the service returned a value for the Conditions property.
int	hashCode()
Integer	priority()	Represents the priority of the routing rule.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRoutingRuleRequest.Builder>	serializableBuilderClass()
CreateRoutingRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasActions

public final boolean hasActions()

For responses, this returns true if the service returned a value for the Actions 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.

actions

public final List<RoutingRuleAction> actions()

Represents a routing rule action. The only supported action is invokeApi.

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 hasActions() method.

Returns:

Represents a routing rule action. The only supported action is invokeApi.

hasConditions

public final boolean hasConditions()

For responses, this returns true if the service returned a value for the Conditions 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.

conditions

public final List<RoutingRuleCondition> conditions()

Represents a condition. Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.

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 hasConditions() method.

Returns:

Represents a condition. Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.

domainName

public final String domainName()

The domain name.

Returns:

The domain name.

domainNameId

public final String domainNameId()

The domain name ID.

Returns:

The domain name ID.

priority

public final Integer priority()

Represents the priority of the routing rule.

Returns:

Represents the priority of the routing rule.

toBuilder

public CreateRoutingRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRoutingRuleRequest.Builder,CreateRoutingRuleRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

builder

public static CreateRoutingRuleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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