software.amazon.awssdk.services.wafv2.model

Class PutManagedRuleSetVersionsRequest

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.PutManagedRuleSetVersionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutManagedRuleSetVersionsRequest.Builder,PutManagedRuleSetVersionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutManagedRuleSetVersionsRequest
extends Wafv2Request
implements ToCopyableBuilder<PutManagedRuleSetVersionsRequest.Builder,PutManagedRuleSetVersionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutManagedRuleSetVersionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutManagedRuleSetVersionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVersionsToPublish() For responses, this returns true if the service returned a value for the VersionsToPublish property.
String	id() A unique identifier for the managed rule set.
String	lockToken() A token used for optimistic locking.
String	name() The name of the managed rule set.
String	recommendedVersion() The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
Scope	scope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
String	scopeAsString() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
List<SdkField<?>>	sdkFields()
static Class<? extends PutManagedRuleSetVersionsRequest.Builder>	serializableBuilderClass()
PutManagedRuleSetVersionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,VersionToPublish>	versionsToPublish() The versions of the named managed rule group that you want to offer to your customers.

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, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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 like get and update.

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 like get and update.

lockToken

public final String lockToken()

A token used for optimistic locking. WAF returns a token to your get and list requests, 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 like update and delete. 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 a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Returns:

A token used for optimistic locking. WAF returns a token to your get and list requests, 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 like update and delete. 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 a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

recommendedVersion

public final String recommendedVersion()

The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.

Returns:

The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.

hasVersionsToPublish

public final boolean hasVersionsToPublish()

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

versionsToPublish

public final Map<String,VersionToPublish> versionsToPublish()

The versions of the named managed rule group that you want to offer to your customers.

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

Returns:

The versions of the named managed rule group that you want to offer to your customers.

toBuilder

public PutManagedRuleSetVersionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutManagedRuleSetVersionsRequest.Builder,PutManagedRuleSetVersionsRequest>

Specified by:

toBuilder in class Wafv2Request

builder

public static PutManagedRuleSetVersionsRequest.Builder builder()

serializableBuilderClass

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