com.amazonaws.services.datapipeline.model.DescribeObjectsRequest 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#describeObjects(DescribeObjectsRequest) DescribeObjects operation}.
*
* Returns the object definitions for a set of objects associated with
* the pipeline. Object definitions are composed of a set of fields that
* define the properties of the object.
*
*
* @see com.amazonaws.services.datapipeline.DataPipeline#describeObjects(DescribeObjectsRequest)
*/
public class DescribeObjectsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* Identifier of the pipeline that contains the object definitions.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String pipelineId;
/**
* Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag objectIds;
/**
* Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*/
private Boolean evaluateExpressions;
/**
* The starting point for the results to be returned. The first time you
* call DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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;
/**
* Identifier of the pipeline that contains the object definitions.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return Identifier of the pipeline that contains the object definitions.
*/
public String getPipelineId() {
return pipelineId;
}
/**
* Identifier of the pipeline that contains the object definitions.
*
* Constraints:
* Length: 1 - 1024
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param pipelineId Identifier of the pipeline that contains the object definitions.
*/
public void setPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
}
/**
* Identifier of the pipeline that contains the object definitions.
*
* 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 that contains the object definitions.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeObjectsRequest withPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
return this;
}
/**
* Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*
* @return Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*/
public java.util.List getObjectIds() {
if (objectIds == null) {
objectIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
objectIds.setAutoConstruct(true);
}
return objectIds;
}
/**
* Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*
* @param objectIds Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*/
public void setObjectIds(java.util.Collection objectIds) {
if (objectIds == null) {
this.objectIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag objectIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(objectIds.size());
objectIdsCopy.addAll(objectIds);
this.objectIds = objectIdsCopy;
}
/**
* Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param objectIds Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeObjectsRequest withObjectIds(String... objectIds) {
if (getObjectIds() == null) setObjectIds(new java.util.ArrayList(objectIds.length));
for (String value : objectIds) {
getObjectIds().add(value);
}
return this;
}
/**
* Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param objectIds Identifiers of the pipeline objects that contain the definitions to be
* described. You can pass as many as 25 identifiers in a single call to
* DescribeObjects.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeObjectsRequest withObjectIds(java.util.Collection objectIds) {
if (objectIds == null) {
this.objectIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag objectIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(objectIds.size());
objectIdsCopy.addAll(objectIds);
this.objectIds = objectIdsCopy;
}
return this;
}
/**
* Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*
* @return Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*/
public Boolean isEvaluateExpressions() {
return evaluateExpressions;
}
/**
* Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*
* @param evaluateExpressions Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*/
public void setEvaluateExpressions(Boolean evaluateExpressions) {
this.evaluateExpressions = evaluateExpressions;
}
/**
* Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param evaluateExpressions Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeObjectsRequest withEvaluateExpressions(Boolean evaluateExpressions) {
this.evaluateExpressions = evaluateExpressions;
return this;
}
/**
* Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*
* @return Indicates whether any expressions in the object should be evaluated
* when the object descriptions are returned.
*/
public Boolean getEvaluateExpressions() {
return evaluateExpressions;
}
/**
* The starting point for the results to be returned. The first time you
* call DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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 DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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 DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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 DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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 DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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 DescribeObjects, this value should be empty. As long as
* the action returns HasMoreResults as True,
* you can call DescribeObjects 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 DescribeObjectsRequest withMarker(String marker) {
this.marker = marker;
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 (getObjectIds() != null) sb.append("ObjectIds: " + getObjectIds() + ",");
if (isEvaluateExpressions() != null) sb.append("EvaluateExpressions: " + isEvaluateExpressions() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() );
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 + ((getObjectIds() == null) ? 0 : getObjectIds().hashCode());
hashCode = prime * hashCode + ((isEvaluateExpressions() == null) ? 0 : isEvaluateExpressions().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeObjectsRequest == false) return false;
DescribeObjectsRequest other = (DescribeObjectsRequest)obj;
if (other.getPipelineId() == null ^ this.getPipelineId() == null) return false;
if (other.getPipelineId() != null && other.getPipelineId().equals(this.getPipelineId()) == false) return false;
if (other.getObjectIds() == null ^ this.getObjectIds() == null) return false;
if (other.getObjectIds() != null && other.getObjectIds().equals(this.getObjectIds()) == false) return false;
if (other.isEvaluateExpressions() == null ^ this.isEvaluateExpressions() == null) return false;
if (other.isEvaluateExpressions() != null && other.isEvaluateExpressions().equals(this.isEvaluateExpressions()) == false) return false;
if (other.getMarker() == null ^ this.getMarker() == null) return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false) return false;
return true;
}
}