software.amazon.awssdk.services.eventbridge.model.DescribeApiDestinationResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eventbridge Show documentation
Show all versions of eventbridge Show documentation
The AWS Java SDK for EventBridge module holds the client classes that are used for
communicating with EventBridge.
/*
* 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.eventbridge.model;
import java.time.Instant;
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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeApiDestinationResponse extends EventBridgeResponse implements
ToCopyableBuilder {
private static final SdkField API_DESTINATION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApiDestinationArn").getter(getter(DescribeApiDestinationResponse::apiDestinationArn))
.setter(setter(Builder::apiDestinationArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApiDestinationArn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(DescribeApiDestinationResponse::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DescribeApiDestinationResponse::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField API_DESTINATION_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApiDestinationState").getter(getter(DescribeApiDestinationResponse::apiDestinationStateAsString))
.setter(setter(Builder::apiDestinationState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApiDestinationState").build())
.build();
private static final SdkField CONNECTION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConnectionArn").getter(getter(DescribeApiDestinationResponse::connectionArn))
.setter(setter(Builder::connectionArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectionArn").build()).build();
private static final SdkField INVOCATION_ENDPOINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InvocationEndpoint").getter(getter(DescribeApiDestinationResponse::invocationEndpoint))
.setter(setter(Builder::invocationEndpoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InvocationEndpoint").build())
.build();
private static final SdkField HTTP_METHOD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HttpMethod").getter(getter(DescribeApiDestinationResponse::httpMethodAsString))
.setter(setter(Builder::httpMethod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HttpMethod").build()).build();
private static final SdkField INVOCATION_RATE_LIMIT_PER_SECOND_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("InvocationRateLimitPerSecond")
.getter(getter(DescribeApiDestinationResponse::invocationRateLimitPerSecond))
.setter(setter(Builder::invocationRateLimitPerSecond))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InvocationRateLimitPerSecond")
.build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeApiDestinationResponse::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTime").getter(getter(DescribeApiDestinationResponse::lastModifiedTime))
.setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(API_DESTINATION_ARN_FIELD,
NAME_FIELD, DESCRIPTION_FIELD, API_DESTINATION_STATE_FIELD, CONNECTION_ARN_FIELD, INVOCATION_ENDPOINT_FIELD,
HTTP_METHOD_FIELD, INVOCATION_RATE_LIMIT_PER_SECOND_FIELD, CREATION_TIME_FIELD, LAST_MODIFIED_TIME_FIELD));
private final String apiDestinationArn;
private final String name;
private final String description;
private final String apiDestinationState;
private final String connectionArn;
private final String invocationEndpoint;
private final String httpMethod;
private final Integer invocationRateLimitPerSecond;
private final Instant creationTime;
private final Instant lastModifiedTime;
private DescribeApiDestinationResponse(BuilderImpl builder) {
super(builder);
this.apiDestinationArn = builder.apiDestinationArn;
this.name = builder.name;
this.description = builder.description;
this.apiDestinationState = builder.apiDestinationState;
this.connectionArn = builder.connectionArn;
this.invocationEndpoint = builder.invocationEndpoint;
this.httpMethod = builder.httpMethod;
this.invocationRateLimitPerSecond = builder.invocationRateLimitPerSecond;
this.creationTime = builder.creationTime;
this.lastModifiedTime = builder.lastModifiedTime;
}
/**
*
* The ARN of the API destination retrieved.
*
*
* @return The ARN of the API destination retrieved.
*/
public final String apiDestinationArn() {
return apiDestinationArn;
}
/**
*
* The name of the API destination retrieved.
*
*
* @return The name of the API destination retrieved.
*/
public final String name() {
return name;
}
/**
*
* The description for the API destination retrieved.
*
*
* @return The description for the API destination retrieved.
*/
public final String description() {
return description;
}
/**
*
* The state of the API destination retrieved.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #apiDestinationState} will return {@link ApiDestinationState#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #apiDestinationStateAsString}.
*
*
* @return The state of the API destination retrieved.
* @see ApiDestinationState
*/
public final ApiDestinationState apiDestinationState() {
return ApiDestinationState.fromValue(apiDestinationState);
}
/**
*
* The state of the API destination retrieved.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #apiDestinationState} will return {@link ApiDestinationState#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #apiDestinationStateAsString}.
*
*
* @return The state of the API destination retrieved.
* @see ApiDestinationState
*/
public final String apiDestinationStateAsString() {
return apiDestinationState;
}
/**
*
* The ARN of the connection specified for the API destination retrieved.
*
*
* @return The ARN of the connection specified for the API destination retrieved.
*/
public final String connectionArn() {
return connectionArn;
}
/**
*
* The URL to use to connect to the HTTP endpoint.
*
*
* @return The URL to use to connect to the HTTP endpoint.
*/
public final String invocationEndpoint() {
return invocationEndpoint;
}
/**
*
* The method to use to connect to the HTTP endpoint.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #httpMethod} will
* return {@link ApiDestinationHttpMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #httpMethodAsString}.
*
*
* @return The method to use to connect to the HTTP endpoint.
* @see ApiDestinationHttpMethod
*/
public final ApiDestinationHttpMethod httpMethod() {
return ApiDestinationHttpMethod.fromValue(httpMethod);
}
/**
*
* The method to use to connect to the HTTP endpoint.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #httpMethod} will
* return {@link ApiDestinationHttpMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #httpMethodAsString}.
*
*
* @return The method to use to connect to the HTTP endpoint.
* @see ApiDestinationHttpMethod
*/
public final String httpMethodAsString() {
return httpMethod;
}
/**
*
* The maximum number of invocations per second to specified for the API destination. Note that if you set the
* invocation rate maximum to a value lower the rate necessary to send all events received on to the destination
* HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate
* lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are
* not delivered within 24 hours.
*
*
* @return The maximum number of invocations per second to specified for the API destination. Note that if you set
* the invocation rate maximum to a value lower the rate necessary to send all events received on to the
* destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan
* to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue
* to catch events that are not delivered within 24 hours.
*/
public final Integer invocationRateLimitPerSecond() {
return invocationRateLimitPerSecond;
}
/**
*
* A time stamp for the time that the API destination was created.
*
*
* @return A time stamp for the time that the API destination was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* A time stamp for the time that the API destination was last modified.
*
*
* @return A time stamp for the time that the API destination was last modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(apiDestinationArn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(apiDestinationStateAsString());
hashCode = 31 * hashCode + Objects.hashCode(connectionArn());
hashCode = 31 * hashCode + Objects.hashCode(invocationEndpoint());
hashCode = 31 * hashCode + Objects.hashCode(httpMethodAsString());
hashCode = 31 * hashCode + Objects.hashCode(invocationRateLimitPerSecond());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeApiDestinationResponse)) {
return false;
}
DescribeApiDestinationResponse other = (DescribeApiDestinationResponse) obj;
return Objects.equals(apiDestinationArn(), other.apiDestinationArn()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description())
&& Objects.equals(apiDestinationStateAsString(), other.apiDestinationStateAsString())
&& Objects.equals(connectionArn(), other.connectionArn())
&& Objects.equals(invocationEndpoint(), other.invocationEndpoint())
&& Objects.equals(httpMethodAsString(), other.httpMethodAsString())
&& Objects.equals(invocationRateLimitPerSecond(), other.invocationRateLimitPerSecond())
&& Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime());
}
/**
* 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("DescribeApiDestinationResponse").add("ApiDestinationArn", apiDestinationArn())
.add("Name", name()).add("Description", description()).add("ApiDestinationState", apiDestinationStateAsString())
.add("ConnectionArn", connectionArn()).add("InvocationEndpoint", invocationEndpoint())
.add("HttpMethod", httpMethodAsString()).add("InvocationRateLimitPerSecond", invocationRateLimitPerSecond())
.add("CreationTime", creationTime()).add("LastModifiedTime", lastModifiedTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApiDestinationArn":
return Optional.ofNullable(clazz.cast(apiDestinationArn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "ApiDestinationState":
return Optional.ofNullable(clazz.cast(apiDestinationStateAsString()));
case "ConnectionArn":
return Optional.ofNullable(clazz.cast(connectionArn()));
case "InvocationEndpoint":
return Optional.ofNullable(clazz.cast(invocationEndpoint()));
case "HttpMethod":
return Optional.ofNullable(clazz.cast(httpMethodAsString()));
case "InvocationRateLimitPerSecond":
return Optional.ofNullable(clazz.cast(invocationRateLimitPerSecond()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeApiDestinationResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EventBridgeResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The ARN of the API destination retrieved.
*
*
* @param apiDestinationArn
* The ARN of the API destination retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder apiDestinationArn(String apiDestinationArn);
/**
*
* The name of the API destination retrieved.
*
*
* @param name
* The name of the API destination retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The description for the API destination retrieved.
*
*
* @param description
* The description for the API destination retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The state of the API destination retrieved.
*
*
* @param apiDestinationState
* The state of the API destination retrieved.
* @see ApiDestinationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApiDestinationState
*/
Builder apiDestinationState(String apiDestinationState);
/**
*
* The state of the API destination retrieved.
*
*
* @param apiDestinationState
* The state of the API destination retrieved.
* @see ApiDestinationState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApiDestinationState
*/
Builder apiDestinationState(ApiDestinationState apiDestinationState);
/**
*
* The ARN of the connection specified for the API destination retrieved.
*
*
* @param connectionArn
* The ARN of the connection specified for the API destination retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder connectionArn(String connectionArn);
/**
*
* The URL to use to connect to the HTTP endpoint.
*
*
* @param invocationEndpoint
* The URL to use to connect to the HTTP endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder invocationEndpoint(String invocationEndpoint);
/**
*
* The method to use to connect to the HTTP endpoint.
*
*
* @param httpMethod
* The method to use to connect to the HTTP endpoint.
* @see ApiDestinationHttpMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApiDestinationHttpMethod
*/
Builder httpMethod(String httpMethod);
/**
*
* The method to use to connect to the HTTP endpoint.
*
*
* @param httpMethod
* The method to use to connect to the HTTP endpoint.
* @see ApiDestinationHttpMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApiDestinationHttpMethod
*/
Builder httpMethod(ApiDestinationHttpMethod httpMethod);
/**
*
* The maximum number of invocations per second to specified for the API destination. Note that if you set the
* invocation rate maximum to a value lower the rate necessary to send all events received on to the destination
* HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate
* lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that
* are not delivered within 24 hours.
*
*
* @param invocationRateLimitPerSecond
* The maximum number of invocations per second to specified for the API destination. Note that if you
* set the invocation rate maximum to a value lower the rate necessary to send all events received on to
* the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If
* you plan to set the rate lower than the rate necessary to deliver all events, consider using a
* dead-letter queue to catch events that are not delivered within 24 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder invocationRateLimitPerSecond(Integer invocationRateLimitPerSecond);
/**
*
* A time stamp for the time that the API destination was created.
*
*
* @param creationTime
* A time stamp for the time that the API destination was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* A time stamp for the time that the API destination was last modified.
*
*
* @param lastModifiedTime
* A time stamp for the time that the API destination was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
}
static final class BuilderImpl extends EventBridgeResponse.BuilderImpl implements Builder {
private String apiDestinationArn;
private String name;
private String description;
private String apiDestinationState;
private String connectionArn;
private String invocationEndpoint;
private String httpMethod;
private Integer invocationRateLimitPerSecond;
private Instant creationTime;
private Instant lastModifiedTime;
private BuilderImpl() {
}
private BuilderImpl(DescribeApiDestinationResponse model) {
super(model);
apiDestinationArn(model.apiDestinationArn);
name(model.name);
description(model.description);
apiDestinationState(model.apiDestinationState);
connectionArn(model.connectionArn);
invocationEndpoint(model.invocationEndpoint);
httpMethod(model.httpMethod);
invocationRateLimitPerSecond(model.invocationRateLimitPerSecond);
creationTime(model.creationTime);
lastModifiedTime(model.lastModifiedTime);
}
public final String getApiDestinationArn() {
return apiDestinationArn;
}
public final void setApiDestinationArn(String apiDestinationArn) {
this.apiDestinationArn = apiDestinationArn;
}
@Override
public final Builder apiDestinationArn(String apiDestinationArn) {
this.apiDestinationArn = apiDestinationArn;
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 String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getApiDestinationState() {
return apiDestinationState;
}
public final void setApiDestinationState(String apiDestinationState) {
this.apiDestinationState = apiDestinationState;
}
@Override
public final Builder apiDestinationState(String apiDestinationState) {
this.apiDestinationState = apiDestinationState;
return this;
}
@Override
public final Builder apiDestinationState(ApiDestinationState apiDestinationState) {
this.apiDestinationState(apiDestinationState == null ? null : apiDestinationState.toString());
return this;
}
public final String getConnectionArn() {
return connectionArn;
}
public final void setConnectionArn(String connectionArn) {
this.connectionArn = connectionArn;
}
@Override
public final Builder connectionArn(String connectionArn) {
this.connectionArn = connectionArn;
return this;
}
public final String getInvocationEndpoint() {
return invocationEndpoint;
}
public final void setInvocationEndpoint(String invocationEndpoint) {
this.invocationEndpoint = invocationEndpoint;
}
@Override
public final Builder invocationEndpoint(String invocationEndpoint) {
this.invocationEndpoint = invocationEndpoint;
return this;
}
public final String getHttpMethod() {
return httpMethod;
}
public final void setHttpMethod(String httpMethod) {
this.httpMethod = httpMethod;
}
@Override
public final Builder httpMethod(String httpMethod) {
this.httpMethod = httpMethod;
return this;
}
@Override
public final Builder httpMethod(ApiDestinationHttpMethod httpMethod) {
this.httpMethod(httpMethod == null ? null : httpMethod.toString());
return this;
}
public final Integer getInvocationRateLimitPerSecond() {
return invocationRateLimitPerSecond;
}
public final void setInvocationRateLimitPerSecond(Integer invocationRateLimitPerSecond) {
this.invocationRateLimitPerSecond = invocationRateLimitPerSecond;
}
@Override
public final Builder invocationRateLimitPerSecond(Integer invocationRateLimitPerSecond) {
this.invocationRateLimitPerSecond = invocationRateLimitPerSecond;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final Instant getLastModifiedTime() {
return lastModifiedTime;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
@Override
public DescribeApiDestinationResponse build() {
return new DescribeApiDestinationResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy