com.amazonaws.services.appconfig.model.GetConfigurationRequest Maven / Gradle / Ivy
/*
* Copyright 2018-2023 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.appconfig.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetConfigurationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The application to get. Specify either the application name or the application ID.
*
*/
private String application;
/**
*
* The environment to get. Specify either the environment name or the environment ID.
*
*/
private String environment;
/**
*
* The configuration to get. Specify either the configuration name or the configuration ID.
*
*/
private String configuration;
/**
*
* The clientId parameter in the following command is a unique, user-specified ID to identify the client for the
* configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment
* strategy.
*
*/
private String clientId;
/**
*
* The configuration version returned in the most recent GetConfiguration response.
*
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration
* version on your clients. If you don’t send ClientConfigurationVersion with each call to
* GetConfiguration, your clients receive the current configuration. You are charged each time your
* clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
* continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value to use
* for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned
* by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to
* GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
*
*/
private String clientConfigurationVersion;
/**
*
* The application to get. Specify either the application name or the application ID.
*
*
* @param application
* The application to get. Specify either the application name or the application ID.
*/
public void setApplication(String application) {
this.application = application;
}
/**
*
* The application to get. Specify either the application name or the application ID.
*
*
* @return The application to get. Specify either the application name or the application ID.
*/
public String getApplication() {
return this.application;
}
/**
*
* The application to get. Specify either the application name or the application ID.
*
*
* @param application
* The application to get. Specify either the application name or the application ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConfigurationRequest withApplication(String application) {
setApplication(application);
return this;
}
/**
*
* The environment to get. Specify either the environment name or the environment ID.
*
*
* @param environment
* The environment to get. Specify either the environment name or the environment ID.
*/
public void setEnvironment(String environment) {
this.environment = environment;
}
/**
*
* The environment to get. Specify either the environment name or the environment ID.
*
*
* @return The environment to get. Specify either the environment name or the environment ID.
*/
public String getEnvironment() {
return this.environment;
}
/**
*
* The environment to get. Specify either the environment name or the environment ID.
*
*
* @param environment
* The environment to get. Specify either the environment name or the environment ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConfigurationRequest withEnvironment(String environment) {
setEnvironment(environment);
return this;
}
/**
*
* The configuration to get. Specify either the configuration name or the configuration ID.
*
*
* @param configuration
* The configuration to get. Specify either the configuration name or the configuration ID.
*/
public void setConfiguration(String configuration) {
this.configuration = configuration;
}
/**
*
* The configuration to get. Specify either the configuration name or the configuration ID.
*
*
* @return The configuration to get. Specify either the configuration name or the configuration ID.
*/
public String getConfiguration() {
return this.configuration;
}
/**
*
* The configuration to get. Specify either the configuration name or the configuration ID.
*
*
* @param configuration
* The configuration to get. Specify either the configuration name or the configuration ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConfigurationRequest withConfiguration(String configuration) {
setConfiguration(configuration);
return this;
}
/**
*
* The clientId parameter in the following command is a unique, user-specified ID to identify the client for the
* configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment
* strategy.
*
*
* @param clientId
* The clientId parameter in the following command is a unique, user-specified ID to identify the client for
* the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the
* deployment strategy.
*/
public void setClientId(String clientId) {
this.clientId = clientId;
}
/**
*
* The clientId parameter in the following command is a unique, user-specified ID to identify the client for the
* configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment
* strategy.
*
*
* @return The clientId parameter in the following command is a unique, user-specified ID to identify the client for
* the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the
* deployment strategy.
*/
public String getClientId() {
return this.clientId;
}
/**
*
* The clientId parameter in the following command is a unique, user-specified ID to identify the client for the
* configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment
* strategy.
*
*
* @param clientId
* The clientId parameter in the following command is a unique, user-specified ID to identify the client for
* the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the
* deployment strategy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConfigurationRequest withClientId(String clientId) {
setClientId(clientId);
return this;
}
/**
*
* The configuration version returned in the most recent GetConfiguration response.
*
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration
* version on your clients. If you don’t send ClientConfigurationVersion with each call to
* GetConfiguration, your clients receive the current configuration. You are charged each time your
* clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
* continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value to use
* for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned
* by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to
* GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
*
*
* @param clientConfigurationVersion
* The configuration version returned in the most recent GetConfiguration response.
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the
* configuration version on your clients. If you don’t send ClientConfigurationVersion with each
* call to GetConfiguration, your clients receive the current configuration. You are charged
* each time your clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you
* choose to continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value
* to use for ClientConfigurationVersion comes from the ConfigurationVersion
* attribute returned by GetConfiguration when there is new or updated data, and should be saved
* for subsequent calls to GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
*/
public void setClientConfigurationVersion(String clientConfigurationVersion) {
this.clientConfigurationVersion = clientConfigurationVersion;
}
/**
*
* The configuration version returned in the most recent GetConfiguration response.
*
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration
* version on your clients. If you don’t send ClientConfigurationVersion with each call to
* GetConfiguration, your clients receive the current configuration. You are charged each time your
* clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
* continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value to use
* for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned
* by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to
* GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
*
*
* @return The configuration version returned in the most recent GetConfiguration response.
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the
* configuration version on your clients. If you don’t send ClientConfigurationVersion with
* each call to GetConfiguration, your clients receive the current configuration. You are
* charged each time your clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you
* choose to continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value
* to use for ClientConfigurationVersion comes from the ConfigurationVersion
* attribute returned by GetConfiguration when there is new or updated data, and should be
* saved for subsequent calls to GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
*/
public String getClientConfigurationVersion() {
return this.clientConfigurationVersion;
}
/**
*
* The configuration version returned in the most recent GetConfiguration response.
*
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration
* version on your clients. If you don’t send ClientConfigurationVersion with each call to
* GetConfiguration, your clients receive the current configuration. You are charged each time your
* clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to
* continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value to use
* for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned
* by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to
* GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
*
*
* @param clientConfigurationVersion
* The configuration version returned in the most recent GetConfiguration response.
*
*
* AppConfig uses the value of the ClientConfigurationVersion parameter to identify the
* configuration version on your clients. If you don’t send ClientConfigurationVersion with each
* call to GetConfiguration, your clients receive the current configuration. You are charged
* each time your clients receive a configuration.
*
*
* To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you
* choose to continue using GetConfiguration, we recommend that you include the
* ClientConfigurationVersion value with every call to GetConfiguration. The value
* to use for ClientConfigurationVersion comes from the ConfigurationVersion
* attribute returned by GetConfiguration when there is new or updated data, and should be saved
* for subsequent calls to GetConfiguration.
*
*
*
* For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConfigurationRequest withClientConfigurationVersion(String clientConfigurationVersion) {
setClientConfigurationVersion(clientConfigurationVersion);
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 (getApplication() != null)
sb.append("Application: ").append(getApplication()).append(",");
if (getEnvironment() != null)
sb.append("Environment: ").append(getEnvironment()).append(",");
if (getConfiguration() != null)
sb.append("Configuration: ").append(getConfiguration()).append(",");
if (getClientId() != null)
sb.append("ClientId: ").append(getClientId()).append(",");
if (getClientConfigurationVersion() != null)
sb.append("ClientConfigurationVersion: ").append(getClientConfigurationVersion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetConfigurationRequest == false)
return false;
GetConfigurationRequest other = (GetConfigurationRequest) obj;
if (other.getApplication() == null ^ this.getApplication() == null)
return false;
if (other.getApplication() != null && other.getApplication().equals(this.getApplication()) == false)
return false;
if (other.getEnvironment() == null ^ this.getEnvironment() == null)
return false;
if (other.getEnvironment() != null && other.getEnvironment().equals(this.getEnvironment()) == false)
return false;
if (other.getConfiguration() == null ^ this.getConfiguration() == null)
return false;
if (other.getConfiguration() != null && other.getConfiguration().equals(this.getConfiguration()) == false)
return false;
if (other.getClientId() == null ^ this.getClientId() == null)
return false;
if (other.getClientId() != null && other.getClientId().equals(this.getClientId()) == false)
return false;
if (other.getClientConfigurationVersion() == null ^ this.getClientConfigurationVersion() == null)
return false;
if (other.getClientConfigurationVersion() != null && other.getClientConfigurationVersion().equals(this.getClientConfigurationVersion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getApplication() == null) ? 0 : getApplication().hashCode());
hashCode = prime * hashCode + ((getEnvironment() == null) ? 0 : getEnvironment().hashCode());
hashCode = prime * hashCode + ((getConfiguration() == null) ? 0 : getConfiguration().hashCode());
hashCode = prime * hashCode + ((getClientId() == null) ? 0 : getClientId().hashCode());
hashCode = prime * hashCode + ((getClientConfigurationVersion() == null) ? 0 : getClientConfigurationVersion().hashCode());
return hashCode;
}
@Override
public GetConfigurationRequest clone() {
return (GetConfigurationRequest) super.clone();
}
}