com.amazonaws.services.wafv2.model.DescribeManagedRuleGroupRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* 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 DescribeManagedRuleGroupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule
* group.
*
*/
private String vendorName;
/**
*
* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
*
*/
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, or an App Runner service.
*
*
* 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.
*
*
*
*/
private String scope;
/**
*
* The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't
* provide this, WAF uses the vendor's default version.
*
*/
private String versionName;
/**
*
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule
* group.
*
*
* @param vendorName
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify the
* rule group.
*/
public void setVendorName(String vendorName) {
this.vendorName = vendorName;
}
/**
*
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule
* group.
*
*
* @return The name of the managed rule group vendor. You use this, along with the rule group name, to identify the
* rule group.
*/
public String getVendorName() {
return this.vendorName;
}
/**
*
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule
* group.
*
*
* @param vendorName
* The name of the managed rule group vendor. You use this, along with the rule group name, to identify the
* rule group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeManagedRuleGroupRequest withVendorName(String vendorName) {
setVendorName(vendorName);
return this;
}
/**
*
* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
*
*
* @param name
* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
*
*
* @return The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
*
*
* @param name
* The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeManagedRuleGroupRequest 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, or an App Runner service.
*
*
* 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.
*
*
*
*
* @param 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, or an App Runner service.
*
* 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 Scope
*/
public void setScope(String scope) {
this.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, or an App Runner service.
*
*
* 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.
*
*
*
*
* @return 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, or an App Runner service.
*
* 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 Scope
*/
public String getScope() {
return this.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, or an App Runner service.
*
*
* 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.
*
*
*
*
* @param 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, or an App Runner service.
*
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
public DescribeManagedRuleGroupRequest withScope(String scope) {
setScope(scope);
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, or an App Runner service.
*
*
* 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.
*
*
*
*
* @param 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, or an App Runner service.
*
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
public DescribeManagedRuleGroupRequest withScope(Scope scope) {
this.scope = scope.toString();
return this;
}
/**
*
* The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't
* provide this, WAF uses the vendor's default version.
*
*
* @param versionName
* The version of the rule group. You can only use a version that is not scheduled for expiration. If you
* don't provide this, WAF uses the vendor's default version.
*/
public void setVersionName(String versionName) {
this.versionName = versionName;
}
/**
*
* The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't
* provide this, WAF uses the vendor's default version.
*
*
* @return The version of the rule group. You can only use a version that is not scheduled for expiration. If you
* don't provide this, WAF uses the vendor's default version.
*/
public String getVersionName() {
return this.versionName;
}
/**
*
* The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't
* provide this, WAF uses the vendor's default version.
*
*
* @param versionName
* The version of the rule group. You can only use a version that is not scheduled for expiration. If you
* don't provide this, WAF uses the vendor's default version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeManagedRuleGroupRequest withVersionName(String versionName) {
setVersionName(versionName);
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 (getVendorName() != null)
sb.append("VendorName: ").append(getVendorName()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getScope() != null)
sb.append("Scope: ").append(getScope()).append(",");
if (getVersionName() != null)
sb.append("VersionName: ").append(getVersionName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeManagedRuleGroupRequest == false)
return false;
DescribeManagedRuleGroupRequest other = (DescribeManagedRuleGroupRequest) obj;
if (other.getVendorName() == null ^ this.getVendorName() == null)
return false;
if (other.getVendorName() != null && other.getVendorName().equals(this.getVendorName()) == false)
return false;
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.getVersionName() == null ^ this.getVersionName() == null)
return false;
if (other.getVersionName() != null && other.getVersionName().equals(this.getVersionName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVendorName() == null) ? 0 : getVendorName().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode());
hashCode = prime * hashCode + ((getVersionName() == null) ? 0 : getVersionName().hashCode());
return hashCode;
}
@Override
public DescribeManagedRuleGroupRequest clone() {
return (DescribeManagedRuleGroupRequest) super.clone();
}
}