software.amazon.awssdk.services.fms.model.GetProtectionStatusRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fms Show documentation
Show all versions of fms Show documentation
The AWS Java SDK for FMS module holds the client classes that are used for
communicating with FMS.
/*
* 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.fms.model;
import java.beans.Transient;
import java.time.Instant;
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 GetProtectionStatusRequest extends FmsRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PolicyId").getter(getter(GetProtectionStatusRequest::policyId)).setter(setter(Builder::policyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyId").build()).build();
private static final SdkField MEMBER_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MemberAccountId").getter(getter(GetProtectionStatusRequest::memberAccountId))
.setter(setter(Builder::memberAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MemberAccountId").build()).build();
private static final SdkField START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTime").getter(getter(GetProtectionStatusRequest::startTime)).setter(setter(Builder::startTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartTime").build()).build();
private static final SdkField END_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("EndTime").getter(getter(GetProtectionStatusRequest::endTime)).setter(setter(Builder::endTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndTime").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetProtectionStatusRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(GetProtectionStatusRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_ID_FIELD,
MEMBER_ACCOUNT_ID_FIELD, START_TIME_FIELD, END_TIME_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String policyId;
private final String memberAccountId;
private final Instant startTime;
private final Instant endTime;
private final String nextToken;
private final Integer maxResults;
private GetProtectionStatusRequest(BuilderImpl builder) {
super(builder);
this.policyId = builder.policyId;
this.memberAccountId = builder.memberAccountId;
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The ID of the policy for which you want to get the attack information.
*
*
* @return The ID of the policy for which you want to get the attack information.
*/
public final String policyId() {
return policyId;
}
/**
*
* The Amazon Web Services account that is in scope of the policy that you want to get the details for.
*
*
* @return The Amazon Web Services account that is in scope of the policy that you want to get the details for.
*/
public final String memberAccountId() {
return memberAccountId;
}
/**
*
* The start of the time period to query for the attacks. This is a timestamp type. The request syntax
* listing indicates a number type because the default used by Firewall Manager is Unix time in
* seconds. However, any valid timestamp format is allowed.
*
*
* @return The start of the time period to query for the attacks. This is a timestamp type. The request
* syntax listing indicates a number type because the default used by Firewall Manager is Unix
* time in seconds. However, any valid timestamp format is allowed.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* The end of the time period to query for the attacks. This is a timestamp type. The request syntax
* listing indicates a number type because the default used by Firewall Manager is Unix time in
* seconds. However, any valid timestamp format is allowed.
*
*
* @return The end of the time period to query for the attacks. This is a timestamp type. The request
* syntax listing indicates a number type because the default used by Firewall Manager is Unix
* time in seconds. However, any valid timestamp format is allowed.
*/
public final Instant endTime() {
return endTime;
}
/**
*
* If you specify a value for MaxResults and you have more objects than the number that you specify for
* MaxResults, Firewall Manager returns a NextToken value in the response, which you can
* use to retrieve another group of objects. For the second and subsequent GetProtectionStatus
* requests, specify the value of NextToken from the previous response to get information about another
* batch of objects.
*
*
* @return If you specify a value for MaxResults and you have more objects than the number that you
* specify for MaxResults, Firewall Manager returns a NextToken value in the
* response, which you can use to retrieve another group of objects. For the second and subsequent
* GetProtectionStatus requests, specify the value of NextToken from the previous
* response to get information about another batch of objects.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* Specifies the number of objects that you want Firewall Manager to return for this request. If you have more
* objects than the number that you specify for MaxResults, the response includes a
* NextToken value that you can use to get another batch of objects.
*
*
* @return Specifies the number of objects that you want Firewall Manager to return for this request. If you have
* more objects than the number that you specify for MaxResults, the response includes a
* NextToken value that you can use to get another batch of objects.
*/
public final Integer maxResults() {
return maxResults;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(policyId());
hashCode = 31 * hashCode + Objects.hashCode(memberAccountId());
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(endTime());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetProtectionStatusRequest)) {
return false;
}
GetProtectionStatusRequest other = (GetProtectionStatusRequest) obj;
return Objects.equals(policyId(), other.policyId()) && Objects.equals(memberAccountId(), other.memberAccountId())
&& Objects.equals(startTime(), other.startTime()) && Objects.equals(endTime(), other.endTime())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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 final String toString() {
return ToString.builder("GetProtectionStatusRequest").add("PolicyId", policyId())
.add("MemberAccountId", memberAccountId()).add("StartTime", startTime()).add("EndTime", endTime())
.add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PolicyId":
return Optional.ofNullable(clazz.cast(policyId()));
case "MemberAccountId":
return Optional.ofNullable(clazz.cast(memberAccountId()));
case "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "EndTime":
return Optional.ofNullable(clazz.cast(endTime()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetProtectionStatusRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends FmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the policy for which you want to get the attack information.
*
*
* @param policyId
* The ID of the policy for which you want to get the attack information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyId(String policyId);
/**
*
* The Amazon Web Services account that is in scope of the policy that you want to get the details for.
*
*
* @param memberAccountId
* The Amazon Web Services account that is in scope of the policy that you want to get the details for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder memberAccountId(String memberAccountId);
/**
*
* The start of the time period to query for the attacks. This is a timestamp type. The request
* syntax listing indicates a number type because the default used by Firewall Manager is Unix time
* in seconds. However, any valid timestamp format is allowed.
*
*
* @param startTime
* The start of the time period to query for the attacks. This is a timestamp type. The
* request syntax listing indicates a number type because the default used by Firewall
* Manager is Unix time in seconds. However, any valid timestamp format is allowed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTime(Instant startTime);
/**
*
* The end of the time period to query for the attacks. This is a timestamp type. The request
* syntax listing indicates a number type because the default used by Firewall Manager is Unix time
* in seconds. However, any valid timestamp format is allowed.
*
*
* @param endTime
* The end of the time period to query for the attacks. This is a timestamp type. The
* request syntax listing indicates a number type because the default used by Firewall
* Manager is Unix time in seconds. However, any valid timestamp format is allowed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTime(Instant endTime);
/**
*
* If you specify a value for MaxResults and you have more objects than the number that you specify
* for MaxResults, Firewall Manager returns a NextToken value in the response, which
* you can use to retrieve another group of objects. For the second and subsequent
* GetProtectionStatus requests, specify the value of NextToken from the previous
* response to get information about another batch of objects.
*
*
* @param nextToken
* If you specify a value for MaxResults and you have more objects than the number that you
* specify for MaxResults, Firewall Manager returns a NextToken value in the
* response, which you can use to retrieve another group of objects. For the second and subsequent
* GetProtectionStatus requests, specify the value of NextToken from the
* previous response to get information about another batch of objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Specifies the number of objects that you want Firewall Manager to return for this request. If you have more
* objects than the number that you specify for MaxResults, the response includes a
* NextToken value that you can use to get another batch of objects.
*
*
* @param maxResults
* Specifies the number of objects that you want Firewall Manager to return for this request. If you have
* more objects than the number that you specify for MaxResults, the response includes a
* NextToken value that you can use to get another batch of objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends FmsRequest.BuilderImpl implements Builder {
private String policyId;
private String memberAccountId;
private Instant startTime;
private Instant endTime;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(GetProtectionStatusRequest model) {
super(model);
policyId(model.policyId);
memberAccountId(model.memberAccountId);
startTime(model.startTime);
endTime(model.endTime);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getPolicyId() {
return policyId;
}
public final void setPolicyId(String policyId) {
this.policyId = policyId;
}
@Override
@Transient
public final Builder policyId(String policyId) {
this.policyId = policyId;
return this;
}
public final String getMemberAccountId() {
return memberAccountId;
}
public final void setMemberAccountId(String memberAccountId) {
this.memberAccountId = memberAccountId;
}
@Override
@Transient
public final Builder memberAccountId(String memberAccountId) {
this.memberAccountId = memberAccountId;
return this;
}
public final Instant getStartTime() {
return startTime;
}
public final void setStartTime(Instant startTime) {
this.startTime = startTime;
}
@Override
@Transient
public final Builder startTime(Instant startTime) {
this.startTime = startTime;
return this;
}
public final Instant getEndTime() {
return endTime;
}
public final void setEndTime(Instant endTime) {
this.endTime = endTime;
}
@Override
@Transient
public final Builder endTime(Instant endTime) {
this.endTime = endTime;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
@Transient
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
@Transient
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetProtectionStatusRequest build() {
return new GetProtectionStatusRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy