com.amazonaws.services.location.model.DataSourceConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location 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.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies the data storage option chosen for requesting Places.
*
*
*
* When using Amazon Location Places:
*
*
* -
*
* If using HERE Technologies as a data provider, you can't store results for locations in Japan by setting
* IntendedUse to Storage. parameter.
*
*
* -
*
* Under the MobileAssetTracking or MobilAssetManagement pricing plan, you can't store results
* from your place index resources by setting IntendedUse to Storage. This returns a
* validation exception error.
*
*
*
*
* For more information, see the AWS Service Terms for Amazon
* Location Service.
*
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DataSourceConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies how the results of an operation will be stored by the caller.
*
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
*
*/
private String intendedUse;
/**
*
* Specifies how the results of an operation will be stored by the caller.
*
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
*
*
* @param intendedUse
* Specifies how the results of an operation will be stored by the caller.
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
* @see IntendedUse
*/
public void setIntendedUse(String intendedUse) {
this.intendedUse = intendedUse;
}
/**
*
* Specifies how the results of an operation will be stored by the caller.
*
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
*
*
* @return Specifies how the results of an operation will be stored by the caller.
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
* @see IntendedUse
*/
public String getIntendedUse() {
return this.intendedUse;
}
/**
*
* Specifies how the results of an operation will be stored by the caller.
*
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
*
*
* @param intendedUse
* Specifies how the results of an operation will be stored by the caller.
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
* @return Returns a reference to this object so that method calls can be chained together.
* @see IntendedUse
*/
public DataSourceConfiguration withIntendedUse(String intendedUse) {
setIntendedUse(intendedUse);
return this;
}
/**
*
* Specifies how the results of an operation will be stored by the caller.
*
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
*
*
* @param intendedUse
* Specifies how the results of an operation will be stored by the caller.
*
* Valid values include:
*
*
* -
*
* SingleUse specifies that the results won't be stored.
*
*
* -
*
* Storage specifies that the result can be cached or stored in a database.
*
*
*
*
* Default value: SingleUse
* @return Returns a reference to this object so that method calls can be chained together.
* @see IntendedUse
*/
public DataSourceConfiguration withIntendedUse(IntendedUse intendedUse) {
this.intendedUse = intendedUse.toString();
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 (getIntendedUse() != null)
sb.append("IntendedUse: ").append(getIntendedUse());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DataSourceConfiguration == false)
return false;
DataSourceConfiguration other = (DataSourceConfiguration) obj;
if (other.getIntendedUse() == null ^ this.getIntendedUse() == null)
return false;
if (other.getIntendedUse() != null && other.getIntendedUse().equals(this.getIntendedUse()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIntendedUse() == null) ? 0 : getIntendedUse().hashCode());
return hashCode;
}
@Override
public DataSourceConfiguration clone() {
try {
return (DataSourceConfiguration) 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.location.model.transform.DataSourceConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}