com.amazonaws.services.iotthingsgraph.model.SearchEntitiesRequest Maven / Gradle / Ivy
/*
* 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.iotthingsgraph.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 SearchEntitiesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The entity types for which to search.
*
*/
private java.util.List entityTypes;
/**
*
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
* on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
* that is used in a state.
*
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
* criteria.
*
*/
private java.util.List filters;
/**
*
* The string that specifies the next page of results. Use this when you're paginating results.
*
*/
private String nextToken;
/**
*
* The maximum number of results to return in the response.
*
*/
private Integer maxResults;
/**
*
* The version of the user's namespace. Defaults to the latest version of the user's namespace.
*
*/
private Long namespaceVersion;
/**
*
* The entity types for which to search.
*
*
* @return The entity types for which to search.
* @see EntityType
*/
public java.util.List getEntityTypes() {
return entityTypes;
}
/**
*
* The entity types for which to search.
*
*
* @param entityTypes
* The entity types for which to search.
* @see EntityType
*/
public void setEntityTypes(java.util.Collection entityTypes) {
if (entityTypes == null) {
this.entityTypes = null;
return;
}
this.entityTypes = new java.util.ArrayList(entityTypes);
}
/**
*
* The entity types for which to search.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setEntityTypes(java.util.Collection)} or {@link #withEntityTypes(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param entityTypes
* The entity types for which to search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EntityType
*/
public SearchEntitiesRequest withEntityTypes(String... entityTypes) {
if (this.entityTypes == null) {
setEntityTypes(new java.util.ArrayList(entityTypes.length));
}
for (String ele : entityTypes) {
this.entityTypes.add(ele);
}
return this;
}
/**
*
* The entity types for which to search.
*
*
* @param entityTypes
* The entity types for which to search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EntityType
*/
public SearchEntitiesRequest withEntityTypes(java.util.Collection entityTypes) {
setEntityTypes(entityTypes);
return this;
}
/**
*
* The entity types for which to search.
*
*
* @param entityTypes
* The entity types for which to search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EntityType
*/
public SearchEntitiesRequest withEntityTypes(EntityType... entityTypes) {
java.util.ArrayList entityTypesCopy = new java.util.ArrayList(entityTypes.length);
for (EntityType value : entityTypes) {
entityTypesCopy.add(value.toString());
}
if (getEntityTypes() == null) {
setEntityTypes(entityTypesCopy);
} else {
getEntityTypes().addAll(entityTypesCopy);
}
return this;
}
/**
*
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
* on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
* that is used in a state.
*
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
* criteria.
*
*
* @return Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID
* filters on entities that are used by the entity in the result set. For example, you can filter on the ID
* of a property that is used in a state.
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function
* as AND criteria.
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
* on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
* that is used in a state.
*
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
* criteria.
*
*
* @param filters
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID
* filters on entities that are used by the entity in the result set. For example, you can filter on the ID
* of a property that is used in a state.
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function
* as AND criteria.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
* on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
* that is used in a state.
*
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
* criteria.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID
* filters on entities that are used by the entity in the result set. For example, you can filter on the ID
* of a property that is used in a state.
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function
* as AND criteria.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchEntitiesRequest withFilters(EntityFilter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (EntityFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
* on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
* that is used in a state.
*
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
* criteria.
*
*
* @param filters
* Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
* SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID
* filters on entities that are used by the entity in the result set. For example, you can filter on the ID
* of a property that is used in a state.
*
* Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function
* as AND criteria.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchEntitiesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The string that specifies the next page of results. Use this when you're paginating results.
*
*
* @param nextToken
* The string that specifies the next page of results. Use this when you're paginating results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The string that specifies the next page of results. Use this when you're paginating results.
*
*
* @return The string that specifies the next page of results. Use this when you're paginating results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The string that specifies the next page of results. Use this when you're paginating results.
*
*
* @param nextToken
* The string that specifies the next page of results. Use this when you're paginating results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchEntitiesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return in the response.
*
*
* @param maxResults
* The maximum number of results to return in the response.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in the response.
*
*
* @return The maximum number of results to return in the response.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in the response.
*
*
* @param maxResults
* The maximum number of results to return in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchEntitiesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The version of the user's namespace. Defaults to the latest version of the user's namespace.
*
*
* @param namespaceVersion
* The version of the user's namespace. Defaults to the latest version of the user's namespace.
*/
public void setNamespaceVersion(Long namespaceVersion) {
this.namespaceVersion = namespaceVersion;
}
/**
*
* The version of the user's namespace. Defaults to the latest version of the user's namespace.
*
*
* @return The version of the user's namespace. Defaults to the latest version of the user's namespace.
*/
public Long getNamespaceVersion() {
return this.namespaceVersion;
}
/**
*
* The version of the user's namespace. Defaults to the latest version of the user's namespace.
*
*
* @param namespaceVersion
* The version of the user's namespace. Defaults to the latest version of the user's namespace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SearchEntitiesRequest withNamespaceVersion(Long namespaceVersion) {
setNamespaceVersion(namespaceVersion);
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 (getEntityTypes() != null)
sb.append("EntityTypes: ").append(getEntityTypes()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNamespaceVersion() != null)
sb.append("NamespaceVersion: ").append(getNamespaceVersion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SearchEntitiesRequest == false)
return false;
SearchEntitiesRequest other = (SearchEntitiesRequest) obj;
if (other.getEntityTypes() == null ^ this.getEntityTypes() == null)
return false;
if (other.getEntityTypes() != null && other.getEntityTypes().equals(this.getEntityTypes()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNamespaceVersion() == null ^ this.getNamespaceVersion() == null)
return false;
if (other.getNamespaceVersion() != null && other.getNamespaceVersion().equals(this.getNamespaceVersion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEntityTypes() == null) ? 0 : getEntityTypes().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNamespaceVersion() == null) ? 0 : getNamespaceVersion().hashCode());
return hashCode;
}
@Override
public SearchEntitiesRequest clone() {
return (SearchEntitiesRequest) super.clone();
}
}