com.amazonaws.services.pipes.model.PipeEnrichmentParameters Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pipes Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.pipes.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The parameters required to set up enrichment on your pipe.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PipeEnrichmentParameters implements Serializable, Cloneable, StructuredPojo {
/**
*
* Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript Object
* Notation (JSON) Data Interchange Format.
*
*
* To remove an input template, specify an empty string.
*
*/
private String inputTemplate;
/**
*
* Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
*
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to
* specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're
* using ApiDestinations, the corresponding Connection can also have these values configured. In case of any
* conflicting keys, values from the Connection take precedence.
*
*/
private PipeEnrichmentHttpParameters httpParameters;
/**
*
* Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript Object
* Notation (JSON) Data Interchange Format.
*
*
* To remove an input template, specify an empty string.
*
*
* @param inputTemplate
* Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript
* Object Notation (JSON) Data Interchange Format.
*
* To remove an input template, specify an empty string.
*/
public void setInputTemplate(String inputTemplate) {
this.inputTemplate = inputTemplate;
}
/**
*
* Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript Object
* Notation (JSON) Data Interchange Format.
*
*
* To remove an input template, specify an empty string.
*
*
* @return Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript
* Object Notation (JSON) Data Interchange Format.
*
* To remove an input template, specify an empty string.
*/
public String getInputTemplate() {
return this.inputTemplate;
}
/**
*
* Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript Object
* Notation (JSON) Data Interchange Format.
*
*
* To remove an input template, specify an empty string.
*
*
* @param inputTemplate
* Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the
* enrichment. For more information, see The JavaScript
* Object Notation (JSON) Data Interchange Format.
*
* To remove an input template, specify an empty string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeEnrichmentParameters withInputTemplate(String inputTemplate) {
setInputTemplate(inputTemplate);
return this;
}
/**
*
* Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
*
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to
* specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're
* using ApiDestinations, the corresponding Connection can also have these values configured. In case of any
* conflicting keys, values from the Connection take precedence.
*
*
* @param httpParameters
* Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge
* ApiDestination.
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this
* parameter to specify headers, path parameters, and query string keys/values as part of your target
* invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values
* configured. In case of any conflicting keys, values from the Connection take precedence.
*/
public void setHttpParameters(PipeEnrichmentHttpParameters httpParameters) {
this.httpParameters = httpParameters;
}
/**
*
* Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
*
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to
* specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're
* using ApiDestinations, the corresponding Connection can also have these values configured. In case of any
* conflicting keys, values from the Connection take precedence.
*
*
* @return Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge
* ApiDestination.
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this
* parameter to specify headers, path parameters, and query string keys/values as part of your target
* invoking request. If you're using ApiDestinations, the corresponding Connection can also have these
* values configured. In case of any conflicting keys, values from the Connection take precedence.
*/
public PipeEnrichmentHttpParameters getHttpParameters() {
return this.httpParameters;
}
/**
*
* Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
*
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to
* specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're
* using ApiDestinations, the corresponding Connection can also have these values configured. In case of any
* conflicting keys, values from the Connection take precedence.
*
*
* @param httpParameters
* Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge
* ApiDestination.
*
* If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this
* parameter to specify headers, path parameters, and query string keys/values as part of your target
* invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values
* configured. In case of any conflicting keys, values from the Connection take precedence.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeEnrichmentParameters withHttpParameters(PipeEnrichmentHttpParameters httpParameters) {
setHttpParameters(httpParameters);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInputTemplate() != null)
sb.append("InputTemplate: ").append("***Sensitive Data Redacted***").append(",");
if (getHttpParameters() != null)
sb.append("HttpParameters: ").append(getHttpParameters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PipeEnrichmentParameters == false)
return false;
PipeEnrichmentParameters other = (PipeEnrichmentParameters) obj;
if (other.getInputTemplate() == null ^ this.getInputTemplate() == null)
return false;
if (other.getInputTemplate() != null && other.getInputTemplate().equals(this.getInputTemplate()) == false)
return false;
if (other.getHttpParameters() == null ^ this.getHttpParameters() == null)
return false;
if (other.getHttpParameters() != null && other.getHttpParameters().equals(this.getHttpParameters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInputTemplate() == null) ? 0 : getInputTemplate().hashCode());
hashCode = prime * hashCode + ((getHttpParameters() == null) ? 0 : getHttpParameters().hashCode());
return hashCode;
}
@Override
public PipeEnrichmentParameters clone() {
try {
return (PipeEnrichmentParameters) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.pipes.model.transform.PipeEnrichmentParametersMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}