com.amazonaws.services.wafv2.model

Class PutManagedRuleSetVersionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.wafv2.model.PutManagedRuleSetVersionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutManagedRuleSetVersionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutManagedRuleSetVersionsRequest()

Method Summary

Modifier and Type	Method and Description
PutManagedRuleSetVersionsRequest	addVersionsToPublishEntry(String key, VersionToPublish value) Add a single VersionsToPublish entry
PutManagedRuleSetVersionsRequest	clearVersionsToPublishEntries() Removes all the entries added into VersionsToPublish.
PutManagedRuleSetVersionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getId() A unique identifier for the managed rule set.
String	getLockToken() A token used for optimistic locking.
String	getName() The name of the managed rule set.
String	getRecommendedVersion() The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
String	getScope() Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
Map<String,VersionToPublish>	getVersionsToPublish() The versions of the named managed rule group that you want to offer to your customers.
int	hashCode()
void	setId(String id) A unique identifier for the managed rule set.
void	setLockToken(String lockToken) A token used for optimistic locking.
void	setName(String name) The name of the managed rule set.
void	setRecommendedVersion(String recommendedVersion) The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
void	setScope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
void	setVersionsToPublish(Map<String,VersionToPublish> versionsToPublish) The versions of the named managed rule group that you want to offer to your customers.
String	toString() Returns a string representation of this object.
PutManagedRuleSetVersionsRequest	withId(String id) A unique identifier for the managed rule set.
PutManagedRuleSetVersionsRequest	withLockToken(String lockToken) A token used for optimistic locking.
PutManagedRuleSetVersionsRequest	withName(String name) The name of the managed rule set.
PutManagedRuleSetVersionsRequest	withRecommendedVersion(String recommendedVersion) The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
PutManagedRuleSetVersionsRequest	withScope(Scope scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
PutManagedRuleSetVersionsRequest	withScope(String scope) Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
PutManagedRuleSetVersionsRequest	withVersionsToPublish(Map<String,VersionToPublish> versionsToPublish) The versions of the named managed rule group that you want to offer to your customers.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutManagedRuleSetVersionsRequest

public PutManagedRuleSetVersionsRequest()

Method Detail

setName

public void setName(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.

Parameters:

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.

getName

public String getName()

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.

withName

public PutManagedRuleSetVersionsRequest withName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setScope

public void setScope(String 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.

Parameters:

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.

See Also:

Scope

getScope

public String getScope()

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.

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

withScope

public PutManagedRuleSetVersionsRequest withScope(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Scope

withScope

public PutManagedRuleSetVersionsRequest withScope(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Scope

setId

public void setId(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.

Parameters:

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.

getId

public String getId()

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.

withId

public PutManagedRuleSetVersionsRequest withId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setLockToken

public void setLockToken(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.

Parameters:

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.

getLockToken

public String getLockToken()

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.

withLockToken

public PutManagedRuleSetVersionsRequest withLockToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRecommendedVersion

public void setRecommendedVersion(String recommendedVersion)

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

Parameters:

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

getRecommendedVersion

public String getRecommendedVersion()

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.

withRecommendedVersion

public PutManagedRuleSetVersionsRequest withRecommendedVersion(String recommendedVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getVersionsToPublish

public Map<String,VersionToPublish> getVersionsToPublish()

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

Returns:

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

setVersionsToPublish

public void setVersionsToPublish(Map<String,VersionToPublish> versionsToPublish)

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

Parameters:

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

withVersionsToPublish

public PutManagedRuleSetVersionsRequest withVersionsToPublish(Map<String,VersionToPublish> versionsToPublish)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addVersionsToPublishEntry

public PutManagedRuleSetVersionsRequest addVersionsToPublishEntry(String key,
                                                                  VersionToPublish value)

Add a single VersionsToPublish entry

See Also:

withVersionsToPublish(java.util.Map<java.lang.String, com.amazonaws.services.wafv2.model.VersionToPublish>)

clearVersionsToPublishEntries

public PutManagedRuleSetVersionsRequest clearVersionsToPublishEntries()

Removes all the entries added into VersionsToPublish.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutManagedRuleSetVersionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()