software.amazon.awssdk.services.codebuild.model.BuildSummary Maven / Gradle / Ivy
Show all versions of codebuild 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.codebuild.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
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 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;
/**
*
* Contains summary information about a batch build group.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BuildSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(BuildSummary::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField REQUESTED_ON_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("requestedOn").getter(getter(BuildSummary::requestedOn)).setter(setter(Builder::requestedOn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("requestedOn").build()).build();
private static final SdkField BUILD_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("buildStatus").getter(getter(BuildSummary::buildStatusAsString)).setter(setter(Builder::buildStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("buildStatus").build()).build();
private static final SdkField PRIMARY_ARTIFACT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("primaryArtifact")
.getter(getter(BuildSummary::primaryArtifact)).setter(setter(Builder::primaryArtifact))
.constructor(ResolvedArtifact::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("primaryArtifact").build()).build();
private static final SdkField> SECONDARY_ARTIFACTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("secondaryArtifacts")
.getter(getter(BuildSummary::secondaryArtifacts))
.setter(setter(Builder::secondaryArtifacts))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("secondaryArtifacts").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResolvedArtifact::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, REQUESTED_ON_FIELD,
BUILD_STATUS_FIELD, PRIMARY_ARTIFACT_FIELD, SECONDARY_ARTIFACTS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String arn;
private final Instant requestedOn;
private final String buildStatus;
private final ResolvedArtifact primaryArtifact;
private final List secondaryArtifacts;
private BuildSummary(BuilderImpl builder) {
this.arn = builder.arn;
this.requestedOn = builder.requestedOn;
this.buildStatus = builder.buildStatus;
this.primaryArtifact = builder.primaryArtifact;
this.secondaryArtifacts = builder.secondaryArtifacts;
}
/**
*
* The batch build ARN.
*
*
* @return The batch build ARN.
*/
public final String arn() {
return arn;
}
/**
*
* When the build was started, expressed in Unix time format.
*
*
* @return When the build was started, expressed in Unix time format.
*/
public final Instant requestedOn() {
return requestedOn;
}
/**
*
* The status of the build group.
*
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #buildStatus} will
* return {@link StatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #buildStatusAsString}.
*
*
* @return The status of the build group.
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
* @see StatusType
*/
public final StatusType buildStatus() {
return StatusType.fromValue(buildStatus);
}
/**
*
* The status of the build group.
*
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #buildStatus} will
* return {@link StatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #buildStatusAsString}.
*
*
* @return The status of the build group.
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
* @see StatusType
*/
public final String buildStatusAsString() {
return buildStatus;
}
/**
*
* A ResolvedArtifact object that represents the primary build artifacts for the build group.
*
*
* @return A ResolvedArtifact object that represents the primary build artifacts for the build group.
*/
public final ResolvedArtifact primaryArtifact() {
return primaryArtifact;
}
/**
* For responses, this returns true if the service returned a value for the SecondaryArtifacts 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 hasSecondaryArtifacts() {
return secondaryArtifacts != null && !(secondaryArtifacts instanceof SdkAutoConstructList);
}
/**
*
* An array of ResolvedArtifact objects that represents the secondary build artifacts for the build
* group.
*
*
* 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 #hasSecondaryArtifacts} method.
*
*
* @return An array of ResolvedArtifact objects that represents the secondary build artifacts for the
* build group.
*/
public final List secondaryArtifacts() {
return secondaryArtifacts;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(requestedOn());
hashCode = 31 * hashCode + Objects.hashCode(buildStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(primaryArtifact());
hashCode = 31 * hashCode + Objects.hashCode(hasSecondaryArtifacts() ? secondaryArtifacts() : 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 BuildSummary)) {
return false;
}
BuildSummary other = (BuildSummary) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(requestedOn(), other.requestedOn())
&& Objects.equals(buildStatusAsString(), other.buildStatusAsString())
&& Objects.equals(primaryArtifact(), other.primaryArtifact())
&& hasSecondaryArtifacts() == other.hasSecondaryArtifacts()
&& Objects.equals(secondaryArtifacts(), other.secondaryArtifacts());
}
/**
* 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("BuildSummary").add("Arn", arn()).add("RequestedOn", requestedOn())
.add("BuildStatus", buildStatusAsString()).add("PrimaryArtifact", primaryArtifact())
.add("SecondaryArtifacts", hasSecondaryArtifacts() ? secondaryArtifacts() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "requestedOn":
return Optional.ofNullable(clazz.cast(requestedOn()));
case "buildStatus":
return Optional.ofNullable(clazz.cast(buildStatusAsString()));
case "primaryArtifact":
return Optional.ofNullable(clazz.cast(primaryArtifact()));
case "secondaryArtifacts":
return Optional.ofNullable(clazz.cast(secondaryArtifacts()));
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("arn", ARN_FIELD);
map.put("requestedOn", REQUESTED_ON_FIELD);
map.put("buildStatus", BUILD_STATUS_FIELD);
map.put("primaryArtifact", PRIMARY_ARTIFACT_FIELD);
map.put("secondaryArtifacts", SECONDARY_ARTIFACTS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((BuildSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The batch build ARN.
*
*
* @param arn
* The batch build ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* When the build was started, expressed in Unix time format.
*
*
* @param requestedOn
* When the build was started, expressed in Unix time format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requestedOn(Instant requestedOn);
/**
*
* The status of the build group.
*
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
*
*
* @param buildStatus
* The status of the build group.
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder buildStatus(String buildStatus);
/**
*
* The status of the build group.
*
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
*
*
* @param buildStatus
* The status of the build group.
*
* - FAILED
* -
*
* The build group failed.
*
*
* - FAULT
* -
*
* The build group faulted.
*
*
* - IN_PROGRESS
* -
*
* The build group is still in progress.
*
*
* - STOPPED
* -
*
* The build group stopped.
*
*
* - SUCCEEDED
* -
*
* The build group succeeded.
*
*
* - TIMED_OUT
* -
*
* The build group timed out.
*
*
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder buildStatus(StatusType buildStatus);
/**
*
* A ResolvedArtifact object that represents the primary build artifacts for the build group.
*
*
* @param primaryArtifact
* A ResolvedArtifact object that represents the primary build artifacts for the build
* group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder primaryArtifact(ResolvedArtifact primaryArtifact);
/**
*
* A ResolvedArtifact object that represents the primary build artifacts for the build group.
*
* This is a convenience method that creates an instance of the {@link ResolvedArtifact.Builder} avoiding the
* need to create one manually via {@link ResolvedArtifact#builder()}.
*
*
* When the {@link Consumer} completes, {@link ResolvedArtifact.Builder#build()} is called immediately and its
* result is passed to {@link #primaryArtifact(ResolvedArtifact)}.
*
* @param primaryArtifact
* a consumer that will call methods on {@link ResolvedArtifact.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #primaryArtifact(ResolvedArtifact)
*/
default Builder primaryArtifact(Consumer primaryArtifact) {
return primaryArtifact(ResolvedArtifact.builder().applyMutation(primaryArtifact).build());
}
/**
*
* An array of ResolvedArtifact objects that represents the secondary build artifacts for the build
* group.
*
*
* @param secondaryArtifacts
* An array of ResolvedArtifact objects that represents the secondary build artifacts for
* the build group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secondaryArtifacts(Collection secondaryArtifacts);
/**
*
* An array of ResolvedArtifact objects that represents the secondary build artifacts for the build
* group.
*
*
* @param secondaryArtifacts
* An array of ResolvedArtifact objects that represents the secondary build artifacts for
* the build group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder secondaryArtifacts(ResolvedArtifact... secondaryArtifacts);
/**
*
* An array of ResolvedArtifact objects that represents the secondary build artifacts for the build
* group.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.codebuild.model.ResolvedArtifact.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.codebuild.model.ResolvedArtifact#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.codebuild.model.ResolvedArtifact.Builder#build()} is called
* immediately and its result is passed to {@link #secondaryArtifacts(List)}.
*
* @param secondaryArtifacts
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.codebuild.model.ResolvedArtifact.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #secondaryArtifacts(java.util.Collection)
*/
Builder secondaryArtifacts(Consumer... secondaryArtifacts);
}
static final class BuilderImpl implements Builder {
private String arn;
private Instant requestedOn;
private String buildStatus;
private ResolvedArtifact primaryArtifact;
private List secondaryArtifacts = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BuildSummary model) {
arn(model.arn);
requestedOn(model.requestedOn);
buildStatus(model.buildStatus);
primaryArtifact(model.primaryArtifact);
secondaryArtifacts(model.secondaryArtifacts);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Instant getRequestedOn() {
return requestedOn;
}
public final void setRequestedOn(Instant requestedOn) {
this.requestedOn = requestedOn;
}
@Override
public final Builder requestedOn(Instant requestedOn) {
this.requestedOn = requestedOn;
return this;
}
public final String getBuildStatus() {
return buildStatus;
}
public final void setBuildStatus(String buildStatus) {
this.buildStatus = buildStatus;
}
@Override
public final Builder buildStatus(String buildStatus) {
this.buildStatus = buildStatus;
return this;
}
@Override
public final Builder buildStatus(StatusType buildStatus) {
this.buildStatus(buildStatus == null ? null : buildStatus.toString());
return this;
}
public final ResolvedArtifact.Builder getPrimaryArtifact() {
return primaryArtifact != null ? primaryArtifact.toBuilder() : null;
}
public final void setPrimaryArtifact(ResolvedArtifact.BuilderImpl primaryArtifact) {
this.primaryArtifact = primaryArtifact != null ? primaryArtifact.build() : null;
}
@Override
public final Builder primaryArtifact(ResolvedArtifact primaryArtifact) {
this.primaryArtifact = primaryArtifact;
return this;
}
public final List getSecondaryArtifacts() {
List result = ResolvedSecondaryArtifactsCopier.copyToBuilder(this.secondaryArtifacts);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSecondaryArtifacts(Collection secondaryArtifacts) {
this.secondaryArtifacts = ResolvedSecondaryArtifactsCopier.copyFromBuilder(secondaryArtifacts);
}
@Override
public final Builder secondaryArtifacts(Collection secondaryArtifacts) {
this.secondaryArtifacts = ResolvedSecondaryArtifactsCopier.copy(secondaryArtifacts);
return this;
}
@Override
@SafeVarargs
public final Builder secondaryArtifacts(ResolvedArtifact... secondaryArtifacts) {
secondaryArtifacts(Arrays.asList(secondaryArtifacts));
return this;
}
@Override
@SafeVarargs
public final Builder secondaryArtifacts(Consumer... secondaryArtifacts) {
secondaryArtifacts(Stream.of(secondaryArtifacts).map(c -> ResolvedArtifact.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public BuildSummary build() {
return new BuildSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}