software.amazon.awssdk.services.codepipeline.model.ListWebhookItem Maven / Gradle / Ivy
Show all versions of codepipeline 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.codepipeline.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;
/**
*
* The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the
* webhook ARN.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListWebhookItem implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DEFINITION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("definition")
.getter(getter(ListWebhookItem::definition)).setter(setter(Builder::definition))
.constructor(WebhookDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("definition").build()).build();
private static final SdkField URL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("url")
.getter(getter(ListWebhookItem::url)).setter(setter(Builder::url))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("url").build()).build();
private static final SdkField ERROR_MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("errorMessage").getter(getter(ListWebhookItem::errorMessage)).setter(setter(Builder::errorMessage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("errorMessage").build()).build();
private static final SdkField ERROR_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("errorCode").getter(getter(ListWebhookItem::errorCode)).setter(setter(Builder::errorCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("errorCode").build()).build();
private static final SdkField LAST_TRIGGERED_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("lastTriggered").getter(getter(ListWebhookItem::lastTriggered)).setter(setter(Builder::lastTriggered))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("lastTriggered").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(ListWebhookItem::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(ListWebhookItem::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DEFINITION_FIELD, URL_FIELD,
ERROR_MESSAGE_FIELD, ERROR_CODE_FIELD, LAST_TRIGGERED_FIELD, ARN_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("definition", DEFINITION_FIELD);
put("url", URL_FIELD);
put("errorMessage", ERROR_MESSAGE_FIELD);
put("errorCode", ERROR_CODE_FIELD);
put("lastTriggered", LAST_TRIGGERED_FIELD);
put("arn", ARN_FIELD);
put("tags", TAGS_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final WebhookDefinition definition;
private final String url;
private final String errorMessage;
private final String errorCode;
private final Instant lastTriggered;
private final String arn;
private final List tags;
private ListWebhookItem(BuilderImpl builder) {
this.definition = builder.definition;
this.url = builder.url;
this.errorMessage = builder.errorMessage;
this.errorCode = builder.errorCode;
this.lastTriggered = builder.lastTriggered;
this.arn = builder.arn;
this.tags = builder.tags;
}
/**
*
* The detail returned for each webhook, such as the webhook authentication type and filter rules.
*
*
* @return The detail returned for each webhook, such as the webhook authentication type and filter rules.
*/
public final WebhookDefinition definition() {
return definition;
}
/**
*
* A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started
* as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting
* and re-creating a webhook makes the old URL invalid and generates a new one.
*
*
* @return A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is
* started as long as the body of the post request satisfies the defined authentication and filtering
* conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
*/
public final String url() {
return url;
}
/**
*
* The text of the error message about the webhook.
*
*
* @return The text of the error message about the webhook.
*/
public final String errorMessage() {
return errorMessage;
}
/**
*
* The number code of the error.
*
*
* @return The number code of the error.
*/
public final String errorCode() {
return errorCode;
}
/**
*
* The date and time a webhook was last successfully triggered, in timestamp format.
*
*
* @return The date and time a webhook was last successfully triggered, in timestamp format.
*/
public final Instant lastTriggered() {
return lastTriggered;
}
/**
*
* The Amazon Resource Name (ARN) of the webhook.
*
*
* @return The Amazon Resource Name (ARN) of the webhook.
*/
public final String arn() {
return arn;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* Specifies the tags applied to the webhook.
*
*
* 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 #hasTags} method.
*
*
* @return Specifies the tags applied to the webhook.
*/
public final List tags() {
return tags;
}
@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(definition());
hashCode = 31 * hashCode + Objects.hashCode(url());
hashCode = 31 * hashCode + Objects.hashCode(errorMessage());
hashCode = 31 * hashCode + Objects.hashCode(errorCode());
hashCode = 31 * hashCode + Objects.hashCode(lastTriggered());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 ListWebhookItem)) {
return false;
}
ListWebhookItem other = (ListWebhookItem) obj;
return Objects.equals(definition(), other.definition()) && Objects.equals(url(), other.url())
&& Objects.equals(errorMessage(), other.errorMessage()) && Objects.equals(errorCode(), other.errorCode())
&& Objects.equals(lastTriggered(), other.lastTriggered()) && Objects.equals(arn(), other.arn())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("ListWebhookItem").add("Definition", definition()).add("Url", url())
.add("ErrorMessage", errorMessage()).add("ErrorCode", errorCode()).add("LastTriggered", lastTriggered())
.add("Arn", arn()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "definition":
return Optional.ofNullable(clazz.cast(definition()));
case "url":
return Optional.ofNullable(clazz.cast(url()));
case "errorMessage":
return Optional.ofNullable(clazz.cast(errorMessage()));
case "errorCode":
return Optional.ofNullable(clazz.cast(errorCode()));
case "lastTriggered":
return Optional.ofNullable(clazz.cast(lastTriggered()));
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ListWebhookItem) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The detail returned for each webhook, such as the webhook authentication type and filter rules.
*
*
* @param definition
* The detail returned for each webhook, such as the webhook authentication type and filter rules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder definition(WebhookDefinition definition);
/**
*
* The detail returned for each webhook, such as the webhook authentication type and filter rules.
*
* This is a convenience method that creates an instance of the {@link WebhookDefinition.Builder} avoiding the
* need to create one manually via {@link WebhookDefinition#builder()}.
*
*
* When the {@link Consumer} completes, {@link WebhookDefinition.Builder#build()} is called immediately and its
* result is passed to {@link #definition(WebhookDefinition)}.
*
* @param definition
* a consumer that will call methods on {@link WebhookDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #definition(WebhookDefinition)
*/
default Builder definition(Consumer definition) {
return definition(WebhookDefinition.builder().applyMutation(definition).build());
}
/**
*
* A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is
* started as long as the body of the post request satisfies the defined authentication and filtering
* conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
*
*
* @param url
* A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline
* is started as long as the body of the post request satisfies the defined authentication and filtering
* conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder url(String url);
/**
*
* The text of the error message about the webhook.
*
*
* @param errorMessage
* The text of the error message about the webhook.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorMessage(String errorMessage);
/**
*
* The number code of the error.
*
*
* @param errorCode
* The number code of the error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorCode(String errorCode);
/**
*
* The date and time a webhook was last successfully triggered, in timestamp format.
*
*
* @param lastTriggered
* The date and time a webhook was last successfully triggered, in timestamp format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastTriggered(Instant lastTriggered);
/**
*
* The Amazon Resource Name (ARN) of the webhook.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the webhook.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* Specifies the tags applied to the webhook.
*
*
* @param tags
* Specifies the tags applied to the webhook.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Specifies the tags applied to the webhook.
*
*
* @param tags
* Specifies the tags applied to the webhook.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Specifies the tags applied to the webhook.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.codepipeline.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.codepipeline.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.codepipeline.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.codepipeline.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
}
static final class BuilderImpl implements Builder {
private WebhookDefinition definition;
private String url;
private String errorMessage;
private String errorCode;
private Instant lastTriggered;
private String arn;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListWebhookItem model) {
definition(model.definition);
url(model.url);
errorMessage(model.errorMessage);
errorCode(model.errorCode);
lastTriggered(model.lastTriggered);
arn(model.arn);
tags(model.tags);
}
public final WebhookDefinition.Builder getDefinition() {
return definition != null ? definition.toBuilder() : null;
}
public final void setDefinition(WebhookDefinition.BuilderImpl definition) {
this.definition = definition != null ? definition.build() : null;
}
@Override
public final Builder definition(WebhookDefinition definition) {
this.definition = definition;
return this;
}
public final String getUrl() {
return url;
}
public final void setUrl(String url) {
this.url = url;
}
@Override
public final Builder url(String url) {
this.url = url;
return this;
}
public final String getErrorMessage() {
return errorMessage;
}
public final void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
@Override
public final Builder errorMessage(String errorMessage) {
this.errorMessage = errorMessage;
return this;
}
public final String getErrorCode() {
return errorCode;
}
public final void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
@Override
public final Builder errorCode(String errorCode) {
this.errorCode = errorCode;
return this;
}
public final Instant getLastTriggered() {
return lastTriggered;
}
public final void setLastTriggered(Instant lastTriggered) {
this.lastTriggered = lastTriggered;
}
@Override
public final Builder lastTriggered(Instant lastTriggered) {
this.lastTriggered = lastTriggered;
return this;
}
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 List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ListWebhookItem build() {
return new ListWebhookItem(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}