Class CreateRuleRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.vpclattice.model.VpcLatticeRequest
-
- software.amazon.awssdk.services.vpclattice.model.CreateRuleRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRuleRequest extends VpcLatticeRequest implements ToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateRuleRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RuleActionaction()The action for the default rule.static CreateRuleRequest.Builderbuilder()StringclientToken()A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringlistenerIdentifier()The ID or Amazon Resource Name (ARN) of the listener.RuleMatchmatch()The rule match.Stringname()The name of the rule.Integerpriority()The priority assigned to the rule.List<SdkField<?>>sdkFields()static Class<? extends CreateRuleRequest.Builder>serializableBuilderClass()StringserviceIdentifier()The ID or Amazon Resource Name (ARN) of the service.Map<String,String>tags()The tags for the rule.CreateRuleRequest.BuildertoBuilder()StringtoString()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
-
action
public final RuleAction action()
The action for the default rule.
- Returns:
- The action for the default rule.
-
clientToken
public final String clientToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
-
listenerIdentifier
public final String listenerIdentifier()
The ID or Amazon Resource Name (ARN) of the listener.
- Returns:
- The ID or Amazon Resource Name (ARN) of the listener.
-
match
public final RuleMatch match()
The rule match.
- Returns:
- The rule match.
-
name
public final String name()
The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
- Returns:
- The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
-
priority
public final Integer priority()
The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
- Returns:
- The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
-
serviceIdentifier
public final String serviceIdentifier()
The ID or Amazon Resource Name (ARN) of the service.
- Returns:
- The ID or Amazon Resource Name (ARN) of the service.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final Map<String,String> tags()
The tags for the rule.
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
hasTags()method.- Returns:
- The tags for the rule.
-
toBuilder
public CreateRuleRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateRuleRequest.Builder,CreateRuleRequest>- Specified by:
toBuilderin classVpcLatticeRequest
-
builder
public static CreateRuleRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateRuleRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-