com.amazonaws.services.datapipeline.model.QueryObjectsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.datapipeline.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.datapipeline.DataPipeline#queryObjects(QueryObjectsRequest) QueryObjects operation}.
*
* Queries a pipeline for the names of objects that match a specified set
* of conditions.
*
*
* The objects returned by QueryObjects are paginated and then filtered
* by the value you set for query. This means the action may return an
* empty result set with a value set for marker. If
* HasMoreResults is set to True , you should
* continue to call QueryObjects, passing in the returned value for
* marker, until HasMoreResults returns False .
*
*
* @see com.amazonaws.services.datapipeline.DataPipeline#queryObjects(QueryObjectsRequest)
*/
public class QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* Identifier of the pipeline to be queried for object names.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String pipelineId;
/**
* Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*/
private Query query;
/**
* Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String sphere;
/**
* The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String marker;
/**
* Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*/
private Integer limit;
/**
* Identifier of the pipeline to be queried for object names.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return Identifier of the pipeline to be queried for object names.
*/
public String getPipelineId() {
return pipelineId;
}
/**
* Identifier of the pipeline to be queried for object names.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param pipelineId Identifier of the pipeline to be queried for object names.
*/
public void setPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
}
/**
* Identifier of the pipeline to be queried for object names.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param pipelineId Identifier of the pipeline to be queried for object names.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public QueryObjectsRequest withPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
return this;
}
/**
* Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*
* @return Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*/
public Query getQuery() {
return query;
}
/**
* Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*
* @param query Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*/
public void setQuery(Query query) {
this.query = query;
}
/**
* Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param query Query that defines the objects to be returned. The Query object
* can contain a maximum of ten selectors. The conditions in the query
* are limited to top-level String fields in the object. These filters
* can be applied to components, instances, and attempts.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public QueryObjectsRequest withQuery(Query query) {
this.query = query;
return this;
}
/**
* Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*/
public String getSphere() {
return sphere;
}
/**
* Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param sphere Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*/
public void setSphere(String sphere) {
this.sphere = sphere;
}
/**
* Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param sphere Specifies whether the query applies to components or instances.
* Allowable values: COMPONENT, INSTANCE,
* ATTEMPT.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public QueryObjectsRequest withSphere(String sphere) {
this.sphere = sphere;
return this;
}
/**
* The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*/
public String getMarker() {
return marker;
}
/**
* The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param marker The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param marker The starting point for the results to be returned. The first time you
* call QueryObjects, this value should be empty. As long as the
* action returns HasMoreResults as True, you
* can call QueryObjects again and pass the marker value from the
* response to retrieve the next set of results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public QueryObjectsRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*
* @return Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*/
public Integer getLimit() {
return limit;
}
/**
* Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*
* @param limit Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
* Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param limit Specifies the maximum number of object names that QueryObjects
* will return in a single call. The default value is 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public QueryObjectsRequest withLimit(Integer limit) {
this.limit = limit;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPipelineId() != null) sb.append("PipelineId: " + getPipelineId() + ",");
if (getQuery() != null) sb.append("Query: " + getQuery() + ",");
if (getSphere() != null) sb.append("Sphere: " + getSphere() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() + ",");
if (getLimit() != null) sb.append("Limit: " + getLimit() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPipelineId() == null) ? 0 : getPipelineId().hashCode());
hashCode = prime * hashCode + ((getQuery() == null) ? 0 : getQuery().hashCode());
hashCode = prime * hashCode + ((getSphere() == null) ? 0 : getSphere().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof QueryObjectsRequest == false) return false;
QueryObjectsRequest other = (QueryObjectsRequest)obj;
if (other.getPipelineId() == null ^ this.getPipelineId() == null) return false;
if (other.getPipelineId() != null && other.getPipelineId().equals(this.getPipelineId()) == false) return false;
if (other.getQuery() == null ^ this.getQuery() == null) return false;
if (other.getQuery() != null && other.getQuery().equals(this.getQuery()) == false) return false;
if (other.getSphere() == null ^ this.getSphere() == null) return false;
if (other.getSphere() != null && other.getSphere().equals(this.getSphere()) == false) return false;
if (other.getMarker() == null ^ this.getMarker() == null) return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false;
if (other.getLimit() == null ^ this.getLimit() == null) return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false) return false;
return true;
}
}