software.amazon.awssdk.services.synthetics.model.CanaryRun 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.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.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;
/**
*
* This structure contains the details about one run of one canary.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CanaryRun implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(CanaryRun::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CanaryRun::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Status").getter(getter(CanaryRun::status)).setter(setter(Builder::status))
.constructor(CanaryRunStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField TIMELINE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Timeline").getter(getter(CanaryRun::timeline))
.setter(setter(Builder::timeline)).constructor(CanaryRunTimeline::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Timeline").build()).build();
private static final SdkField ARTIFACT_S3_LOCATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ArtifactS3Location").getter(getter(CanaryRun::artifactS3Location))
.setter(setter(Builder::artifactS3Location))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ArtifactS3Location").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, NAME_FIELD,
STATUS_FIELD, TIMELINE_FIELD, ARTIFACT_S3_LOCATION_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String name;
private final CanaryRunStatus status;
private final CanaryRunTimeline timeline;
private final String artifactS3Location;
private CanaryRun(BuilderImpl builder) {
this.id = builder.id;
this.name = builder.name;
this.status = builder.status;
this.timeline = builder.timeline;
this.artifactS3Location = builder.artifactS3Location;
}
/**
*
* A unique ID that identifies this canary run.
*
*
* @return A unique ID that identifies this canary run.
*/
public final String id() {
return id;
}
/**
*
* The name of the canary.
*
*
* @return The name of the canary.
*/
public final String name() {
return name;
}
/**
*
* The status of this run.
*
*
* @return The status of this run.
*/
public final CanaryRunStatus status() {
return status;
}
/**
*
* A structure that contains the start and end times of this run.
*
*
* @return A structure that contains the start and end times of this run.
*/
public final CanaryRunTimeline timeline() {
return timeline;
}
/**
*
* The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR
* files.
*
*
* @return The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots,
* and HAR files.
*/
public final String artifactS3Location() {
return artifactS3Location;
}
@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(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(timeline());
hashCode = 31 * hashCode + Objects.hashCode(artifactS3Location());
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 CanaryRun)) {
return false;
}
CanaryRun other = (CanaryRun) obj;
return Objects.equals(id(), other.id()) && Objects.equals(name(), other.name())
&& Objects.equals(status(), other.status()) && Objects.equals(timeline(), other.timeline())
&& Objects.equals(artifactS3Location(), other.artifactS3Location());
}
/**
* 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("CanaryRun").add("Id", id()).add("Name", name()).add("Status", status())
.add("Timeline", timeline()).add("ArtifactS3Location", artifactS3Location()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
case "Timeline":
return Optional.ofNullable(clazz.cast(timeline()));
case "ArtifactS3Location":
return Optional.ofNullable(clazz.cast(artifactS3Location()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CanaryRun) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A unique ID that identifies this canary run.
*
*
* @param id
* A unique ID that identifies this canary run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The name of the canary.
*
*
* @param name
* The name of the canary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The status of this run.
*
*
* @param status
* The status of this run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(CanaryRunStatus status);
/**
*
* The status of this run.
*
* This is a convenience method that creates an instance of the {@link CanaryRunStatus.Builder} avoiding the
* need to create one manually via {@link CanaryRunStatus#builder()}.
*
*
* When the {@link Consumer} completes, {@link CanaryRunStatus.Builder#build()} is called immediately and its
* result is passed to {@link #status(CanaryRunStatus)}.
*
* @param status
* a consumer that will call methods on {@link CanaryRunStatus.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #status(CanaryRunStatus)
*/
default Builder status(Consumer status) {
return status(CanaryRunStatus.builder().applyMutation(status).build());
}
/**
*
* A structure that contains the start and end times of this run.
*
*
* @param timeline
* A structure that contains the start and end times of this run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timeline(CanaryRunTimeline timeline);
/**
*
* A structure that contains the start and end times of this run.
*
* This is a convenience method that creates an instance of the {@link CanaryRunTimeline.Builder} avoiding the
* need to create one manually via {@link CanaryRunTimeline#builder()}.
*
*
* When the {@link Consumer} completes, {@link CanaryRunTimeline.Builder#build()} is called immediately and its
* result is passed to {@link #timeline(CanaryRunTimeline)}.
*
* @param timeline
* a consumer that will call methods on {@link CanaryRunTimeline.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #timeline(CanaryRunTimeline)
*/
default Builder timeline(Consumer timeline) {
return timeline(CanaryRunTimeline.builder().applyMutation(timeline).build());
}
/**
*
* The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and
* HAR files.
*
*
* @param artifactS3Location
* The location where the canary stored artifacts from the run. Artifacts include the log file,
* screenshots, and HAR files.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder artifactS3Location(String artifactS3Location);
}
static final class BuilderImpl implements Builder {
private String id;
private String name;
private CanaryRunStatus status;
private CanaryRunTimeline timeline;
private String artifactS3Location;
private BuilderImpl() {
}
private BuilderImpl(CanaryRun model) {
id(model.id);
name(model.name);
status(model.status);
timeline(model.timeline);
artifactS3Location(model.artifactS3Location);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final CanaryRunStatus.Builder getStatus() {
return status != null ? status.toBuilder() : null;
}
public final void setStatus(CanaryRunStatus.BuilderImpl status) {
this.status = status != null ? status.build() : null;
}
@Override
public final Builder status(CanaryRunStatus status) {
this.status = status;
return this;
}
public final CanaryRunTimeline.Builder getTimeline() {
return timeline != null ? timeline.toBuilder() : null;
}
public final void setTimeline(CanaryRunTimeline.BuilderImpl timeline) {
this.timeline = timeline != null ? timeline.build() : null;
}
@Override
public final Builder timeline(CanaryRunTimeline timeline) {
this.timeline = timeline;
return this;
}
public final String getArtifactS3Location() {
return artifactS3Location;
}
public final void setArtifactS3Location(String artifactS3Location) {
this.artifactS3Location = artifactS3Location;
}
@Override
public final Builder artifactS3Location(String artifactS3Location) {
this.artifactS3Location = artifactS3Location;
return this;
}
@Override
public CanaryRun build() {
return new CanaryRun(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}