Class UpdateManagedRuleSetVersionExpiryDateRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.wafv2.model.Wafv2Request
-
- software.amazon.awssdk.services.wafv2.model.UpdateManagedRuleSetVersionExpiryDateRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateManagedRuleSetVersionExpiryDateRequest.Builder,UpdateManagedRuleSetVersionExpiryDateRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateManagedRuleSetVersionExpiryDateRequest extends Wafv2Request implements ToCopyableBuilder<UpdateManagedRuleSetVersionExpiryDateRequest.Builder,UpdateManagedRuleSetVersionExpiryDateRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateManagedRuleSetVersionExpiryDateRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateManagedRuleSetVersionExpiryDateRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantexpiryTimestamp()The time that you want the version to expire.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()A unique identifier for the managed rule set.StringlockToken()A token used for optimistic locking.Stringname()The name of the managed rule set.Scopescope()Specifies whether this is for an Amazon CloudFront distribution or for a regional application.StringscopeAsString()Specifies whether this is for an Amazon CloudFront distribution or for a regional application.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateManagedRuleSetVersionExpiryDateRequest.Builder>serializableBuilderClass()UpdateManagedRuleSetVersionExpiryDateRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringversionToExpire()The version that you want to remove from your list of offerings for the named managed rule group.-
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
-
name
public final String name()
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
- Returns:
- The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
-
scope
public final Scope scope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
If the service returns an enum value that is not available in the current SDK version,
scopewill returnScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromscopeAsString().- Returns:
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
- See Also:
Scope
-
-
scopeAsString
public final String scopeAsString()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
If the service returns an enum value that is not available in the current SDK version,
scopewill returnScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromscopeAsString().- Returns:
- Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional
application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL
API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access
instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
-
- See Also:
Scope
-
-
id
public final String id()
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations likegetandupdate.- Returns:
- A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations likegetandupdate.
-
lockToken
public final String lockToken()
A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.- Returns:
- A token used for optimistic locking. WAF returns a token to your
getandlistrequests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdateanddelete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.
-
versionToExpire
public final String versionToExpire()
The version that you want to remove from your list of offerings for the named managed rule group.
- Returns:
- The version that you want to remove from your list of offerings for the named managed rule group.
-
expiryTimestamp
public final Instant expiryTimestamp()
The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
- Returns:
- The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
-
toBuilder
public UpdateManagedRuleSetVersionExpiryDateRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateManagedRuleSetVersionExpiryDateRequest.Builder,UpdateManagedRuleSetVersionExpiryDateRequest>- Specified by:
toBuilderin classWafv2Request
-
builder
public static UpdateManagedRuleSetVersionExpiryDateRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateManagedRuleSetVersionExpiryDateRequest.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
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-