software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest Maven / Gradle / Ivy
Show all versions of backup Show documentation
/*
* 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.backup.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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 ListRecoveryPointsByResourceRequest extends BackupRequest implements
ToCopyableBuilder {
private static final SdkField RESOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceArn").getter(getter(ListRecoveryPointsByResourceRequest::resourceArn))
.setter(setter(Builder::resourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("resourceArn").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListRecoveryPointsByResourceRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListRecoveryPointsByResourceRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField MANAGED_BY_AWS_BACKUP_ONLY_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("ManagedByAWSBackupOnly")
.getter(getter(ListRecoveryPointsByResourceRequest::managedByAWSBackupOnly))
.setter(setter(Builder::managedByAWSBackupOnly))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("managedByAWSBackupOnly").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESOURCE_ARN_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, MANAGED_BY_AWS_BACKUP_ONLY_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String resourceArn;
private final String nextToken;
private final Integer maxResults;
private final Boolean managedByAWSBackupOnly;
private ListRecoveryPointsByResourceRequest(BuilderImpl builder) {
super(builder);
this.resourceArn = builder.resourceArn;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.managedByAWSBackupOnly = builder.managedByAWSBackupOnly;
}
/**
*
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*
*
* @return An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
public final String resourceArn() {
return resourceArn;
}
/**
*
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your list
* starting at the location pointed to by the next token.
*
*
* @return The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your
* list starting at the location pointed to by the next token.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of items to be returned.
*
*
*
* Amazon RDS requires a value of at least 20.
*
*
*
* @return The maximum number of items to be returned.
*
* Amazon RDS requires a value of at least 20.
*
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* This attribute filters recovery points based on ownership.
*
*
* If this is set to TRUE, the response will contain recovery points associated with the selected
* resources that are managed by Backup.
*
*
* If this is set to FALSE, the response will contain all recovery points associated with the selected
* resource.
*
*
* Type: Boolean
*
*
* @return This attribute filters recovery points based on ownership.
*
* If this is set to TRUE, the response will contain recovery points associated with the
* selected resources that are managed by Backup.
*
*
* If this is set to FALSE, the response will contain all recovery points associated with the
* selected resource.
*
*
* Type: Boolean
*/
public final Boolean managedByAWSBackupOnly() {
return managedByAWSBackupOnly;
}
@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(resourceArn());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(managedByAWSBackupOnly());
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 ListRecoveryPointsByResourceRequest)) {
return false;
}
ListRecoveryPointsByResourceRequest other = (ListRecoveryPointsByResourceRequest) obj;
return Objects.equals(resourceArn(), other.resourceArn()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(managedByAWSBackupOnly(), other.managedByAWSBackupOnly());
}
/**
* 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("ListRecoveryPointsByResourceRequest").add("ResourceArn", resourceArn())
.add("NextToken", nextToken()).add("MaxResults", maxResults())
.add("ManagedByAWSBackupOnly", managedByAWSBackupOnly()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ResourceArn":
return Optional.ofNullable(clazz.cast(resourceArn()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "ManagedByAWSBackupOnly":
return Optional.ofNullable(clazz.cast(managedByAWSBackupOnly()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("resourceArn", RESOURCE_ARN_FIELD);
map.put("nextToken", NEXT_TOKEN_FIELD);
map.put("maxResults", MAX_RESULTS_FIELD);
map.put("managedByAWSBackupOnly", MANAGED_BY_AWS_BACKUP_ONLY_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListRecoveryPointsByResourceRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends BackupRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*
*
* @param resourceArn
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArn(String resourceArn);
/**
*
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in your list
* starting at the location pointed to by the next token.
*
*
* @param nextToken
* The next item following a partial list of returned items. For example, if a request is made to return
* MaxResults number of items, NextToken allows you to return more items in
* your list starting at the location pointed to by the next token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of items to be returned.
*
*
*
* Amazon RDS requires a value of at least 20.
*
*
*
* @param maxResults
* The maximum number of items to be returned.
*
* Amazon RDS requires a value of at least 20.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* This attribute filters recovery points based on ownership.
*
*
* If this is set to TRUE, the response will contain recovery points associated with the selected
* resources that are managed by Backup.
*
*
* If this is set to FALSE, the response will contain all recovery points associated with the
* selected resource.
*
*
* Type: Boolean
*
*
* @param managedByAWSBackupOnly
* This attribute filters recovery points based on ownership.
*
* If this is set to TRUE, the response will contain recovery points associated with the
* selected resources that are managed by Backup.
*
*
* If this is set to FALSE, the response will contain all recovery points associated with
* the selected resource.
*
*
* Type: Boolean
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder managedByAWSBackupOnly(Boolean managedByAWSBackupOnly);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends BackupRequest.BuilderImpl implements Builder {
private String resourceArn;
private String nextToken;
private Integer maxResults;
private Boolean managedByAWSBackupOnly;
private BuilderImpl() {
}
private BuilderImpl(ListRecoveryPointsByResourceRequest model) {
super(model);
resourceArn(model.resourceArn);
nextToken(model.nextToken);
maxResults(model.maxResults);
managedByAWSBackupOnly(model.managedByAWSBackupOnly);
}
public final String getResourceArn() {
return resourceArn;
}
public final void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
@Override
public final Builder resourceArn(String resourceArn) {
this.resourceArn = resourceArn;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
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
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final Boolean getManagedByAWSBackupOnly() {
return managedByAWSBackupOnly;
}
public final void setManagedByAWSBackupOnly(Boolean managedByAWSBackupOnly) {
this.managedByAWSBackupOnly = managedByAWSBackupOnly;
}
@Override
public final Builder managedByAWSBackupOnly(Boolean managedByAWSBackupOnly) {
this.managedByAWSBackupOnly = managedByAWSBackupOnly;
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 ListRecoveryPointsByResourceRequest build() {
return new ListRecoveryPointsByResourceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}