com.amazonaws.services.datapipeline.model.DescribeObjectsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datapipeline Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* Contains the parameters for DescribeObjects.
*
*/
public class DescribeObjectsRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* The ID of the pipeline that contains the object definitions.
*
*/
private String pipelineId;
/**
*
* The IDs 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.SdkInternalList 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. For the first call,
* this value should be empty. As long as there are more results, continue
* to call DescribeObjects with the marker value from the
* previous call to retrieve the next set of results.
*
*/
private String marker;
/**
*
* The ID of the pipeline that contains the object definitions.
*
*
* @param pipelineId
* The ID of the pipeline that contains the object definitions.
*/
public void setPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
}
/**
*
* The ID of the pipeline that contains the object definitions.
*
*
* @return The ID of the pipeline that contains the object definitions.
*/
public String getPipelineId() {
return this.pipelineId;
}
/**
*
* The ID of the pipeline that contains the object definitions.
*
*
* @param pipelineId
* The ID of the pipeline that contains the object definitions.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeObjectsRequest withPipelineId(String pipelineId) {
setPipelineId(pipelineId);
return this;
}
/**
*
* The IDs 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 The IDs 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.SdkInternalList();
}
return objectIds;
}
/**
*
* The IDs 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
* The IDs 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;
}
this.objectIds = new com.amazonaws.internal.SdkInternalList(
objectIds);
}
/**
*
* The IDs 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.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setObjectIds(java.util.Collection)} or
* {@link #withObjectIds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param objectIds
* The IDs 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 Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeObjectsRequest withObjectIds(String... objectIds) {
if (this.objectIds == null) {
setObjectIds(new com.amazonaws.internal.SdkInternalList(
objectIds.length));
}
for (String ele : objectIds) {
this.objectIds.add(ele);
}
return this;
}
/**
*
* The IDs 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
* The IDs 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 Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeObjectsRequest withObjectIds(
java.util.Collection objectIds) {
setObjectIds(objectIds);
return this;
}
/**
*
* 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.
*
*
* @return Indicates whether any expressions in the object should be
* evaluated when the object descriptions are returned.
*/
public Boolean getEvaluateExpressions() {
return this.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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeObjectsRequest withEvaluateExpressions(
Boolean evaluateExpressions) {
setEvaluateExpressions(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 isEvaluateExpressions() {
return this.evaluateExpressions;
}
/**
*
* The starting point for the results to be returned. For the first call,
* this value should be empty. As long as there are more results, continue
* to call DescribeObjects with the marker value from the
* previous call to retrieve the next set of results.
*
*
* @param marker
* The starting point for the results to be returned. For the first
* call, this value should be empty. As long as there are more
* results, continue to call DescribeObjects with the
* marker value from the previous call to retrieve the next set of
* results.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* The starting point for the results to be returned. For the first call,
* this value should be empty. As long as there are more results, continue
* to call DescribeObjects with the marker value from the
* previous call to retrieve the next set of results.
*
*
* @return The starting point for the results to be returned. For the first
* call, this value should be empty. As long as there are more
* results, continue to call DescribeObjects with the
* marker value from the previous call to retrieve the next set of
* results.
*/
public String getMarker() {
return this.marker;
}
/**
*
* The starting point for the results to be returned. For the first call,
* this value should be empty. As long as there are more results, continue
* to call DescribeObjects with the marker value from the
* previous call to retrieve the next set of results.
*
*
* @param marker
* The starting point for the results to be returned. For the first
* call, this value should be empty. As long as there are more
* results, continue to call DescribeObjects with the
* marker value from the previous call to retrieve the next set of
* results.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeObjectsRequest withMarker(String marker) {
setMarker(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 (getEvaluateExpressions() != null)
sb.append("EvaluateExpressions: " + getEvaluateExpressions() + ",");
if (getMarker() != null)
sb.append("Marker: " + getMarker());
sb.append("}");
return sb.toString();
}
@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.getEvaluateExpressions() == null
^ this.getEvaluateExpressions() == null)
return false;
if (other.getEvaluateExpressions() != null
&& other.getEvaluateExpressions().equals(
this.getEvaluateExpressions()) == 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;
}
@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
+ ((getEvaluateExpressions() == null) ? 0
: getEvaluateExpressions().hashCode());
hashCode = prime * hashCode
+ ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public DescribeObjectsRequest clone() {
return (DescribeObjectsRequest) super.clone();
}
}