software.amazon.awssdk.services.wafv2.model.GetRuleGroupRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.wafv2.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetRuleGroupRequest extends Wafv2Request implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(GetRuleGroupRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField SCOPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Scope")
.getter(getter(GetRuleGroupRequest::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(GetRuleGroupRequest::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, SCOPE_FIELD,
ID_FIELD));
private final String name;
private final String scope;
private final String id;
private GetRuleGroupRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.scope = builder.scope;
this.id = builder.id;
}
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @return The name of the rule group. You cannot change the name of a rule group after you create it.
*/
public String name() {
return name;
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* 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, {@link #scope} will return
* {@link Scope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* 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 Scope scope() {
return Scope.fromValue(scope);
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* 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, {@link #scope} will return
* {@link Scope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* 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 scopeAsString() {
return scope;
}
/**
*
* A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You
* provide it to operations like update and delete.
*
*
* @return A unique identifier for the rule group. This ID is returned in the responses to create and list commands.
* You provide it to operations like update and delete.
*/
public String id() {
return id;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(scopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(id());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetRuleGroupRequest)) {
return false;
}
GetRuleGroupRequest other = (GetRuleGroupRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(scopeAsString(), other.scopeAsString())
&& Objects.equals(id(), other.id());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("GetRuleGroupRequest").add("Name", name()).add("Scope", scopeAsString()).add("Id", id()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Scope":
return Optional.ofNullable(clazz.cast(scopeAsString()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetRuleGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @param name
* The name of the rule group. You cannot change the name of a rule group after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* 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 AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* 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
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
Builder scope(String scope);
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* 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 AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* 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
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
Builder scope(Scope scope);
/**
*
* A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You
* provide it to operations like update and delete.
*
*
* @param id
* A unique identifier for the rule group. This ID is returned in the responses to create and list
* commands. You provide it to operations like update and delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Wafv2Request.BuilderImpl implements Builder {
private String name;
private String scope;
private String id;
private BuilderImpl() {
}
private BuilderImpl(GetRuleGroupRequest model) {
super(model);
name(model.name);
scope(model.scope);
id(model.id);
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final String getScope() {
return scope;
}
@Override
public final Builder scope(String scope) {
this.scope = scope;
return this;
}
@Override
public final Builder scope(Scope scope) {
this.scope(scope == null ? null : scope.toString());
return this;
}
public final void setScope(String scope) {
this.scope = scope;
}
public final String getId() {
return id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final void setId(String id) {
this.id = id;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetRuleGroupRequest build() {
return new GetRuleGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}