com.amazonaws.services.kendra.model.ProxyConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra 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.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides the configuration information for a web proxy to connect to website hosts.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ProxyConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the website host you want to connect to via a web proxy server.
*
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
*
*/
private String host;
/**
*
* The port number of the website host you want to connect to via a web proxy server.
*
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
*
*/
private Integer port;
/**
*
* Your secret ARN, which you can create in Secrets Manager
*
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a website
* host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores
* your credentials.
*
*/
private String credentials;
/**
*
* The name of the website host you want to connect to via a web proxy server.
*
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
*
*
* @param host
* The name of the website host you want to connect to via a web proxy server.
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
*/
public void setHost(String host) {
this.host = host;
}
/**
*
* The name of the website host you want to connect to via a web proxy server.
*
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
*
*
* @return The name of the website host you want to connect to via a web proxy server.
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
*/
public String getHost() {
return this.host;
}
/**
*
* The name of the website host you want to connect to via a web proxy server.
*
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
*
*
* @param host
* The name of the website host you want to connect to via a web proxy server.
*
* For example, the host name of https://a.example.com/page1.html is "a.example.com".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProxyConfiguration withHost(String host) {
setHost(host);
return this;
}
/**
*
* The port number of the website host you want to connect to via a web proxy server.
*
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
*
*
* @param port
* The port number of the website host you want to connect to via a web proxy server.
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port number of the website host you want to connect to via a web proxy server.
*
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
*
*
* @return The port number of the website host you want to connect to via a web proxy server.
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port number of the website host you want to connect to via a web proxy server.
*
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
*
*
* @param port
* The port number of the website host you want to connect to via a web proxy server.
*
* For example, the port for https://a.example.com/page1.html is 443, the standard port for HTTPS.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProxyConfiguration withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* Your secret ARN, which you can create in Secrets Manager
*
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a website
* host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores
* your credentials.
*
*
* @param credentials
* Your secret ARN, which you can create in Secrets Manager
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a
* website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The
* secret stores your credentials.
*/
public void setCredentials(String credentials) {
this.credentials = credentials;
}
/**
*
* Your secret ARN, which you can create in Secrets Manager
*
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a website
* host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores
* your credentials.
*
*
* @return Your secret ARN, which you can create in Secrets Manager
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a
* website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The
* secret stores your credentials.
*/
public String getCredentials() {
return this.credentials;
}
/**
*
* Your secret ARN, which you can create in Secrets Manager
*
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a website
* host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The secret stores
* your credentials.
*
*
* @param credentials
* Your secret ARN, which you can create in Secrets Manager
*
* The credentials are optional. You use a secret if web proxy credentials are required to connect to a
* website host. Amazon Kendra currently support basic authentication to connect to a web proxy server. The
* secret stores your credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProxyConfiguration withCredentials(String credentials) {
setCredentials(credentials);
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 (getHost() != null)
sb.append("Host: ").append(getHost()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getCredentials() != null)
sb.append("Credentials: ").append(getCredentials());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ProxyConfiguration == false)
return false;
ProxyConfiguration other = (ProxyConfiguration) obj;
if (other.getHost() == null ^ this.getHost() == null)
return false;
if (other.getHost() != null && other.getHost().equals(this.getHost()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getCredentials() == null ^ this.getCredentials() == null)
return false;
if (other.getCredentials() != null && other.getCredentials().equals(this.getCredentials()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHost() == null) ? 0 : getHost().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getCredentials() == null) ? 0 : getCredentials().hashCode());
return hashCode;
}
@Override
public ProxyConfiguration clone() {
try {
return (ProxyConfiguration) 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.kendra.model.transform.ProxyConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}