software.amazon.awssdk.services.accessanalyzer.model.Location 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.accessanalyzer.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A location in a policy that is represented as a path through the JSON representation and a corresponding span.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Location implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> PATH_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("path")
.getter(getter(Location::path))
.setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("path").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PathElement::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SPAN_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("span")
.getter(getter(Location::span)).setter(setter(Builder::span)).constructor(Span::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("span").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_FIELD, SPAN_FIELD));
private static final long serialVersionUID = 1L;
private final List path;
private final Span span;
private Location(BuilderImpl builder) {
this.path = builder.path;
this.span = builder.span;
}
/**
* For responses, this returns true if the service returned a value for the Path property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasPath() {
return path != null && !(path instanceof SdkAutoConstructList);
}
/**
*
* A path in a policy, represented as a sequence of path elements.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasPath} method.
*
*
* @return A path in a policy, represented as a sequence of path elements.
*/
public final List path() {
return path;
}
/**
*
* A span in a policy.
*
*
* @return A span in a policy.
*/
public final Span span() {
return span;
}
@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 + Objects.hashCode(hasPath() ? path() : null);
hashCode = 31 * hashCode + Objects.hashCode(span());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Location)) {
return false;
}
Location other = (Location) obj;
return hasPath() == other.hasPath() && Objects.equals(path(), other.path()) && Objects.equals(span(), other.span());
}
/**
* 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("Location").add("Path", hasPath() ? path() : null).add("Span", span()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "path":
return Optional.ofNullable(clazz.cast(path()));
case "span":
return Optional.ofNullable(clazz.cast(span()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Location) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A path in a policy, represented as a sequence of path elements.
*
*
* @param path
* A path in a policy, represented as a sequence of path elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(Collection path);
/**
*
* A path in a policy, represented as a sequence of path elements.
*
*
* @param path
* A path in a policy, represented as a sequence of path elements.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(PathElement... path);
/**
*
* A path in a policy, represented as a sequence of path elements.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.accessanalyzer.model.PathElement.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.accessanalyzer.model.PathElement#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.accessanalyzer.model.PathElement.Builder#build()} is called
* immediately and its result is passed to {@link #path(List)}.
*
* @param path
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.accessanalyzer.model.PathElement.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #path(java.util.Collection)
*/
Builder path(Consumer... path);
/**
*
* A span in a policy.
*
*
* @param span
* A span in a policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder span(Span span);
/**
*
* A span in a policy.
*
* This is a convenience method that creates an instance of the {@link Span.Builder} avoiding the need to create
* one manually via {@link Span#builder()}.
*
*
* When the {@link Consumer} completes, {@link Span.Builder#build()} is called immediately and its result is
* passed to {@link #span(Span)}.
*
* @param span
* a consumer that will call methods on {@link Span.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #span(Span)
*/
default Builder span(Consumer span) {
return span(Span.builder().applyMutation(span).build());
}
}
static final class BuilderImpl implements Builder {
private List path = DefaultSdkAutoConstructList.getInstance();
private Span span;
private BuilderImpl() {
}
private BuilderImpl(Location model) {
path(model.path);
span(model.span);
}
public final List getPath() {
List result = PathElementListCopier.copyToBuilder(this.path);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPath(Collection path) {
this.path = PathElementListCopier.copyFromBuilder(path);
}
@Override
public final Builder path(Collection path) {
this.path = PathElementListCopier.copy(path);
return this;
}
@Override
@SafeVarargs
public final Builder path(PathElement... path) {
path(Arrays.asList(path));
return this;
}
@Override
@SafeVarargs
public final Builder path(Consumer... path) {
path(Stream.of(path).map(c -> PathElement.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Span.Builder getSpan() {
return span != null ? span.toBuilder() : null;
}
public final void setSpan(Span.BuilderImpl span) {
this.span = span != null ? span.build() : null;
}
@Override
public final Builder span(Span span) {
this.span = span;
return this;
}
@Override
public Location build() {
return new Location(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}