/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateManagedRuleSetVersionExpiryDateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ private String name; /** ** 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. *
*
* 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
.
*
* 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.
*
* The version that you want to remove from your list of offerings for the named managed rule group. *
*/ private String versionToExpire; /** ** 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". *
*/ private java.util.Date expiryTimestamp; /** ** 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. *
* * @param 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. */ public void setName(String name) { this.name = 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. *
* * @return 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. */ public String getName() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateManagedRuleSetVersionExpiryDateRequest withName(String name) { setName(name); return this; } /** *
* 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
** 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. *
*
* 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
.
*
list
. You provide it to operations like get
and update
.
*/
public void setId(String id) {
this.id = 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
.
*
list
. You provide it to operations like get
and update
.
*/
public String getId() {
return this.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
.
*
list
. You provide it to operations like get
and update
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateManagedRuleSetVersionExpiryDateRequest withId(String id) {
setId(id);
return this;
}
/**
*
* 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.
*
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.
*/
public void setLockToken(String lockToken) {
this.lockToken = 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.
*
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.
*/
public String getLockToken() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateManagedRuleSetVersionExpiryDateRequest withLockToken(String lockToken) {
setLockToken(lockToken);
return this;
}
/**
* * The version that you want to remove from your list of offerings for the named managed rule group. *
* * @param versionToExpire * The version that you want to remove from your list of offerings for the named managed rule group. */ public void setVersionToExpire(String versionToExpire) { this.versionToExpire = versionToExpire; } /** ** The version that you want to remove from your list of offerings for the named managed rule group. *
* * @return The version that you want to remove from your list of offerings for the named managed rule group. */ public String getVersionToExpire() { return this.versionToExpire; } /** ** The version that you want to remove from your list of offerings for the named managed rule group. *
* * @param versionToExpire * The version that you want to remove from your list of offerings for the named managed rule group. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateManagedRuleSetVersionExpiryDateRequest withVersionToExpire(String versionToExpire) { setVersionToExpire(versionToExpire); return this; } /** ** 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". *
* * @param 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". */ public void setExpiryTimestamp(java.util.Date expiryTimestamp) { this.expiryTimestamp = 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". *
* * @return 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". */ public java.util.Date getExpiryTimestamp() { return this.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". *
* * @param 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". * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateManagedRuleSetVersionExpiryDateRequest withExpiryTimestamp(java.util.Date expiryTimestamp) { setExpiryTimestamp(expiryTimestamp); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getScope() != null) sb.append("Scope: ").append(getScope()).append(","); if (getId() != null) sb.append("Id: ").append(getId()).append(","); if (getLockToken() != null) sb.append("LockToken: ").append(getLockToken()).append(","); if (getVersionToExpire() != null) sb.append("VersionToExpire: ").append(getVersionToExpire()).append(","); if (getExpiryTimestamp() != null) sb.append("ExpiryTimestamp: ").append(getExpiryTimestamp()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateManagedRuleSetVersionExpiryDateRequest == false) return false; UpdateManagedRuleSetVersionExpiryDateRequest other = (UpdateManagedRuleSetVersionExpiryDateRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getScope() == null ^ this.getScope() == null) return false; if (other.getScope() != null && other.getScope().equals(this.getScope()) == false) return false; if (other.getId() == null ^ this.getId() == null) return false; if (other.getId() != null && other.getId().equals(this.getId()) == false) return false; if (other.getLockToken() == null ^ this.getLockToken() == null) return false; if (other.getLockToken() != null && other.getLockToken().equals(this.getLockToken()) == false) return false; if (other.getVersionToExpire() == null ^ this.getVersionToExpire() == null) return false; if (other.getVersionToExpire() != null && other.getVersionToExpire().equals(this.getVersionToExpire()) == false) return false; if (other.getExpiryTimestamp() == null ^ this.getExpiryTimestamp() == null) return false; if (other.getExpiryTimestamp() != null && other.getExpiryTimestamp().equals(this.getExpiryTimestamp()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode()); hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode()); hashCode = prime * hashCode + ((getLockToken() == null) ? 0 : getLockToken().hashCode()); hashCode = prime * hashCode + ((getVersionToExpire() == null) ? 0 : getVersionToExpire().hashCode()); hashCode = prime * hashCode + ((getExpiryTimestamp() == null) ? 0 : getExpiryTimestamp().hashCode()); return hashCode; } @Override public UpdateManagedRuleSetVersionExpiryDateRequest clone() { return (UpdateManagedRuleSetVersionExpiryDateRequest) super.clone(); } }