software.amazon.awssdk.services.synthetics.model.BaseScreenshot 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.synthetics.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.Function;
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 structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the
* canary.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BaseScreenshot implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField SCREENSHOT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ScreenshotName").getter(getter(BaseScreenshot::screenshotName)).setter(setter(Builder::screenshotName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScreenshotName").build()).build();
private static final SdkField> IGNORE_COORDINATES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("IgnoreCoordinates")
.getter(getter(BaseScreenshot::ignoreCoordinates))
.setter(setter(Builder::ignoreCoordinates))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IgnoreCoordinates").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SCREENSHOT_NAME_FIELD,
IGNORE_COORDINATES_FIELD));
private static final long serialVersionUID = 1L;
private final String screenshotName;
private final List ignoreCoordinates;
private BaseScreenshot(BuilderImpl builder) {
this.screenshotName = builder.screenshotName;
this.ignoreCoordinates = builder.ignoreCoordinates;
}
/**
*
* The name of the screenshot. This is generated the first time the canary is run after the
* UpdateCanary operation that specified for this canary to perform visual monitoring.
*
*
* @return The name of the screenshot. This is generated the first time the canary is run after the
* UpdateCanary operation that specified for this canary to perform visual monitoring.
*/
public final String screenshotName() {
return screenshotName;
}
/**
* For responses, this returns true if the service returned a value for the IgnoreCoordinates 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 hasIgnoreCoordinates() {
return ignoreCoordinates != null && !(ignoreCoordinates instanceof SdkAutoConstructList);
}
/**
*
* Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates
* to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more information, see
* {LINK}
*
*
* 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 #hasIgnoreCoordinates} method.
*
*
* @return Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
* coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more
* information, see {LINK}
*/
public final List ignoreCoordinates() {
return ignoreCoordinates;
}
@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(screenshotName());
hashCode = 31 * hashCode + Objects.hashCode(hasIgnoreCoordinates() ? ignoreCoordinates() : null);
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 BaseScreenshot)) {
return false;
}
BaseScreenshot other = (BaseScreenshot) obj;
return Objects.equals(screenshotName(), other.screenshotName()) && hasIgnoreCoordinates() == other.hasIgnoreCoordinates()
&& Objects.equals(ignoreCoordinates(), other.ignoreCoordinates());
}
/**
* 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("BaseScreenshot").add("ScreenshotName", screenshotName())
.add("IgnoreCoordinates", hasIgnoreCoordinates() ? ignoreCoordinates() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ScreenshotName":
return Optional.ofNullable(clazz.cast(screenshotName()));
case "IgnoreCoordinates":
return Optional.ofNullable(clazz.cast(ignoreCoordinates()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BaseScreenshot) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the screenshot. This is generated the first time the canary is run after the
* UpdateCanary operation that specified for this canary to perform visual monitoring.
*
*
* @param screenshotName
* The name of the screenshot. This is generated the first time the canary is run after the
* UpdateCanary operation that specified for this canary to perform visual monitoring.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder screenshotName(String screenshotName);
/**
*
* Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
* coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more
* information, see {LINK}
*
*
* @param ignoreCoordinates
* Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
* coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For
* more information, see {LINK}
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ignoreCoordinates(Collection ignoreCoordinates);
/**
*
* Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
* coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For more
* information, see {LINK}
*
*
* @param ignoreCoordinates
* Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the
* coordinates to use here, use the CloudWatch Logs console to draw the boundaries on the screen. For
* more information, see {LINK}
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ignoreCoordinates(String... ignoreCoordinates);
}
static final class BuilderImpl implements Builder {
private String screenshotName;
private List ignoreCoordinates = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BaseScreenshot model) {
screenshotName(model.screenshotName);
ignoreCoordinates(model.ignoreCoordinates);
}
public final String getScreenshotName() {
return screenshotName;
}
public final void setScreenshotName(String screenshotName) {
this.screenshotName = screenshotName;
}
@Override
public final Builder screenshotName(String screenshotName) {
this.screenshotName = screenshotName;
return this;
}
public final Collection getIgnoreCoordinates() {
if (ignoreCoordinates instanceof SdkAutoConstructList) {
return null;
}
return ignoreCoordinates;
}
public final void setIgnoreCoordinates(Collection ignoreCoordinates) {
this.ignoreCoordinates = BaseScreenshotIgnoreCoordinatesCopier.copy(ignoreCoordinates);
}
@Override
public final Builder ignoreCoordinates(Collection ignoreCoordinates) {
this.ignoreCoordinates = BaseScreenshotIgnoreCoordinatesCopier.copy(ignoreCoordinates);
return this;
}
@Override
@SafeVarargs
public final Builder ignoreCoordinates(String... ignoreCoordinates) {
ignoreCoordinates(Arrays.asList(ignoreCoordinates));
return this;
}
@Override
public BaseScreenshot build() {
return new BaseScreenshot(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy