software.amazon.awssdk.services.eventbridge.model.HttpParameters 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.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
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.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.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations. In the
* latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the
* Connection taking precedence.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HttpParameters implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> PATH_PARAMETER_VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PathParameterValues")
.getter(getter(HttpParameters::pathParameterValues))
.setter(setter(Builder::pathParameterValues))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PathParameterValues").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 SdkField> HEADER_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("HeaderParameters")
.getter(getter(HttpParameters::headerParameters))
.setter(setter(Builder::headerParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HeaderParameters").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField> QUERY_STRING_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("QueryStringParameters")
.getter(getter(HttpParameters::queryStringParameters))
.setter(setter(Builder::queryStringParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QueryStringParameters").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_PARAMETER_VALUES_FIELD,
HEADER_PARAMETERS_FIELD, QUERY_STRING_PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final List pathParameterValues;
private final Map headerParameters;
private final Map queryStringParameters;
private HttpParameters(BuilderImpl builder) {
this.pathParameterValues = builder.pathParameterValues;
this.headerParameters = builder.headerParameters;
this.queryStringParameters = builder.queryStringParameters;
}
/**
* For responses, this returns true if the service returned a value for the PathParameterValues 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 hasPathParameterValues() {
return pathParameterValues != null && !(pathParameterValues instanceof SdkAutoConstructList);
}
/**
*
* The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards
* ("*").
*
*
* 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 #hasPathParameterValues} method.
*
*
* @return The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path
* wildcards ("*").
*/
public final List pathParameterValues() {
return pathParameterValues;
}
/**
* For responses, this returns true if the service returned a value for the HeaderParameters 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 hasHeaderParameters() {
return headerParameters != null && !(headerParameters instanceof SdkAutoConstructMap);
}
/**
*
* The headers that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.
*
*
* 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 #hasHeaderParameters} method.
*
*
* @return The headers that need to be sent as part of request invoking the API Gateway API or EventBridge
* ApiDestination.
*/
public final Map headerParameters() {
return headerParameters;
}
/**
* For responses, this returns true if the service returned a value for the QueryStringParameters 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 hasQueryStringParameters() {
return queryStringParameters != null && !(queryStringParameters instanceof SdkAutoConstructMap);
}
/**
*
* The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge
* ApiDestination.
*
*
* 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 #hasQueryStringParameters} method.
*
*
* @return The query string keys/values that need to be sent as part of request invoking the API Gateway API or
* EventBridge ApiDestination.
*/
public final Map queryStringParameters() {
return queryStringParameters;
}
@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(hasPathParameterValues() ? pathParameterValues() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasHeaderParameters() ? headerParameters() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasQueryStringParameters() ? queryStringParameters() : 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 HttpParameters)) {
return false;
}
HttpParameters other = (HttpParameters) obj;
return hasPathParameterValues() == other.hasPathParameterValues()
&& Objects.equals(pathParameterValues(), other.pathParameterValues())
&& hasHeaderParameters() == other.hasHeaderParameters()
&& Objects.equals(headerParameters(), other.headerParameters())
&& hasQueryStringParameters() == other.hasQueryStringParameters()
&& Objects.equals(queryStringParameters(), other.queryStringParameters());
}
/**
* 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("HttpParameters")
.add("PathParameterValues", hasPathParameterValues() ? pathParameterValues() : null)
.add("HeaderParameters", hasHeaderParameters() ? headerParameters() : null)
.add("QueryStringParameters", hasQueryStringParameters() ? queryStringParameters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PathParameterValues":
return Optional.ofNullable(clazz.cast(pathParameterValues()));
case "HeaderParameters":
return Optional.ofNullable(clazz.cast(headerParameters()));
case "QueryStringParameters":
return Optional.ofNullable(clazz.cast(queryStringParameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HttpParameters) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards
* ("*").
*
*
* @param pathParameterValues
* The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path
* wildcards ("*").
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pathParameterValues(Collection pathParameterValues);
/**
*
* The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards
* ("*").
*
*
* @param pathParameterValues
* The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path
* wildcards ("*").
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pathParameterValues(String... pathParameterValues);
/**
*
* The headers that need to be sent as part of request invoking the API Gateway API or EventBridge
* ApiDestination.
*
*
* @param headerParameters
* The headers that need to be sent as part of request invoking the API Gateway API or EventBridge
* ApiDestination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder headerParameters(Map headerParameters);
/**
*
* The query string keys/values that need to be sent as part of request invoking the API Gateway API or
* EventBridge ApiDestination.
*
*
* @param queryStringParameters
* The query string keys/values that need to be sent as part of request invoking the API Gateway API or
* EventBridge ApiDestination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queryStringParameters(Map queryStringParameters);
}
static final class BuilderImpl implements Builder {
private List pathParameterValues = DefaultSdkAutoConstructList.getInstance();
private Map headerParameters = DefaultSdkAutoConstructMap.getInstance();
private Map queryStringParameters = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(HttpParameters model) {
pathParameterValues(model.pathParameterValues);
headerParameters(model.headerParameters);
queryStringParameters(model.queryStringParameters);
}
public final Collection getPathParameterValues() {
if (pathParameterValues instanceof SdkAutoConstructList) {
return null;
}
return pathParameterValues;
}
public final void setPathParameterValues(Collection pathParameterValues) {
this.pathParameterValues = PathParameterListCopier.copy(pathParameterValues);
}
@Override
public final Builder pathParameterValues(Collection pathParameterValues) {
this.pathParameterValues = PathParameterListCopier.copy(pathParameterValues);
return this;
}
@Override
@SafeVarargs
public final Builder pathParameterValues(String... pathParameterValues) {
pathParameterValues(Arrays.asList(pathParameterValues));
return this;
}
public final Map getHeaderParameters() {
if (headerParameters instanceof SdkAutoConstructMap) {
return null;
}
return headerParameters;
}
public final void setHeaderParameters(Map headerParameters) {
this.headerParameters = HeaderParametersMapCopier.copy(headerParameters);
}
@Override
public final Builder headerParameters(Map headerParameters) {
this.headerParameters = HeaderParametersMapCopier.copy(headerParameters);
return this;
}
public final Map getQueryStringParameters() {
if (queryStringParameters instanceof SdkAutoConstructMap) {
return null;
}
return queryStringParameters;
}
public final void setQueryStringParameters(Map queryStringParameters) {
this.queryStringParameters = QueryStringParametersMapCopier.copy(queryStringParameters);
}
@Override
public final Builder queryStringParameters(Map queryStringParameters) {
this.queryStringParameters = QueryStringParametersMapCopier.copy(queryStringParameters);
return this;
}
@Override
public HttpParameters build() {
return new HttpParameters(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy