com.amazonaws.services.codedeploy.model.ListDeploymentsRequest 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.codedeploy.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a ListDeployments operation.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListDeploymentsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
*
*
* If applicationName is specified, then deploymentGroupName must be specified. If it is
* not specified, then deploymentGroupName must not be specified.
*
*
*/
private String applicationName;
/**
*
* The name of a deployment group for the specified application.
*
*
*
* If deploymentGroupName is specified, then applicationName must be specified. If it is
* not specified, then applicationName must not be specified.
*
*
*/
private String deploymentGroupName;
/**
*
* The unique ID of an external resource for returning deployments linked to the external resource.
*
*/
private String externalId;
/**
*
* A subset of deployments to list by status:
*
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList includeOnlyStatuses;
/**
*
* A time range (start and end) for returning a subset of the list of deployments.
*
*/
private TimeRange createTimeRange;
/**
*
* An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
*
*/
private String nextToken;
/**
*
* The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
*
*
* If applicationName is specified, then deploymentGroupName must be specified. If it is
* not specified, then deploymentGroupName must not be specified.
*
*
*
* @param applicationName
* The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
* If applicationName is specified, then deploymentGroupName must be specified. If
* it is not specified, then deploymentGroupName must not be specified.
*
*/
public void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
/**
*
* The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
*
*
* If applicationName is specified, then deploymentGroupName must be specified. If it is
* not specified, then deploymentGroupName must not be specified.
*
*
*
* @return The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
* If applicationName is specified, then deploymentGroupName must be specified. If
* it is not specified, then deploymentGroupName must not be specified.
*
*/
public String getApplicationName() {
return this.applicationName;
}
/**
*
* The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
*
*
* If applicationName is specified, then deploymentGroupName must be specified. If it is
* not specified, then deploymentGroupName must not be specified.
*
*
*
* @param applicationName
* The name of an CodeDeploy application associated with the user or Amazon Web Services account.
*
* If applicationName is specified, then deploymentGroupName must be specified. If
* it is not specified, then deploymentGroupName must not be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDeploymentsRequest withApplicationName(String applicationName) {
setApplicationName(applicationName);
return this;
}
/**
*
* The name of a deployment group for the specified application.
*
*
*
* If deploymentGroupName is specified, then applicationName must be specified. If it is
* not specified, then applicationName must not be specified.
*
*
*
* @param deploymentGroupName
* The name of a deployment group for the specified application.
*
* If deploymentGroupName is specified, then applicationName must be specified. If
* it is not specified, then applicationName must not be specified.
*
*/
public void setDeploymentGroupName(String deploymentGroupName) {
this.deploymentGroupName = deploymentGroupName;
}
/**
*
* The name of a deployment group for the specified application.
*
*
*
* If deploymentGroupName is specified, then applicationName must be specified. If it is
* not specified, then applicationName must not be specified.
*
*
*
* @return The name of a deployment group for the specified application.
*
* If deploymentGroupName is specified, then applicationName must be specified. If
* it is not specified, then applicationName must not be specified.
*
*/
public String getDeploymentGroupName() {
return this.deploymentGroupName;
}
/**
*
* The name of a deployment group for the specified application.
*
*
*
* If deploymentGroupName is specified, then applicationName must be specified. If it is
* not specified, then applicationName must not be specified.
*
*
*
* @param deploymentGroupName
* The name of a deployment group for the specified application.
*
* If deploymentGroupName is specified, then applicationName must be specified. If
* it is not specified, then applicationName must not be specified.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDeploymentsRequest withDeploymentGroupName(String deploymentGroupName) {
setDeploymentGroupName(deploymentGroupName);
return this;
}
/**
*
* The unique ID of an external resource for returning deployments linked to the external resource.
*
*
* @param externalId
* The unique ID of an external resource for returning deployments linked to the external resource.
*/
public void setExternalId(String externalId) {
this.externalId = externalId;
}
/**
*
* The unique ID of an external resource for returning deployments linked to the external resource.
*
*
* @return The unique ID of an external resource for returning deployments linked to the external resource.
*/
public String getExternalId() {
return this.externalId;
}
/**
*
* The unique ID of an external resource for returning deployments linked to the external resource.
*
*
* @param externalId
* The unique ID of an external resource for returning deployments linked to the external resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDeploymentsRequest withExternalId(String externalId) {
setExternalId(externalId);
return this;
}
/**
*
* A subset of deployments to list by status:
*
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
*
*
* @return A subset of deployments to list by status:
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
* @see DeploymentStatus
*/
public java.util.List getIncludeOnlyStatuses() {
if (includeOnlyStatuses == null) {
includeOnlyStatuses = new com.amazonaws.internal.SdkInternalList();
}
return includeOnlyStatuses;
}
/**
*
* A subset of deployments to list by status:
*
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
*
*
* @param includeOnlyStatuses
* A subset of deployments to list by status:
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
* @see DeploymentStatus
*/
public void setIncludeOnlyStatuses(java.util.Collection includeOnlyStatuses) {
if (includeOnlyStatuses == null) {
this.includeOnlyStatuses = null;
return;
}
this.includeOnlyStatuses = new com.amazonaws.internal.SdkInternalList(includeOnlyStatuses);
}
/**
*
* A subset of deployments to list by status:
*
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIncludeOnlyStatuses(java.util.Collection)} or {@link #withIncludeOnlyStatuses(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param includeOnlyStatuses
* A subset of deployments to list by status:
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeploymentStatus
*/
public ListDeploymentsRequest withIncludeOnlyStatuses(String... includeOnlyStatuses) {
if (this.includeOnlyStatuses == null) {
setIncludeOnlyStatuses(new com.amazonaws.internal.SdkInternalList(includeOnlyStatuses.length));
}
for (String ele : includeOnlyStatuses) {
this.includeOnlyStatuses.add(ele);
}
return this;
}
/**
*
* A subset of deployments to list by status:
*
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
*
*
* @param includeOnlyStatuses
* A subset of deployments to list by status:
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeploymentStatus
*/
public ListDeploymentsRequest withIncludeOnlyStatuses(java.util.Collection includeOnlyStatuses) {
setIncludeOnlyStatuses(includeOnlyStatuses);
return this;
}
/**
*
* A subset of deployments to list by status:
*
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
*
*
* @param includeOnlyStatuses
* A subset of deployments to list by status:
*
* -
*
* Created: Include created deployments in the resulting list.
*
*
* -
*
* Queued: Include queued deployments in the resulting list.
*
*
* -
*
* In Progress: Include in-progress deployments in the resulting list.
*
*
* -
*
* Succeeded: Include successful deployments in the resulting list.
*
*
* -
*
* Failed: Include failed deployments in the resulting list.
*
*
* -
*
* Stopped: Include stopped deployments in the resulting list.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeploymentStatus
*/
public ListDeploymentsRequest withIncludeOnlyStatuses(DeploymentStatus... includeOnlyStatuses) {
com.amazonaws.internal.SdkInternalList includeOnlyStatusesCopy = new com.amazonaws.internal.SdkInternalList(includeOnlyStatuses.length);
for (DeploymentStatus value : includeOnlyStatuses) {
includeOnlyStatusesCopy.add(value.toString());
}
if (getIncludeOnlyStatuses() == null) {
setIncludeOnlyStatuses(includeOnlyStatusesCopy);
} else {
getIncludeOnlyStatuses().addAll(includeOnlyStatusesCopy);
}
return this;
}
/**
*
* A time range (start and end) for returning a subset of the list of deployments.
*
*
* @param createTimeRange
* A time range (start and end) for returning a subset of the list of deployments.
*/
public void setCreateTimeRange(TimeRange createTimeRange) {
this.createTimeRange = createTimeRange;
}
/**
*
* A time range (start and end) for returning a subset of the list of deployments.
*
*
* @return A time range (start and end) for returning a subset of the list of deployments.
*/
public TimeRange getCreateTimeRange() {
return this.createTimeRange;
}
/**
*
* A time range (start and end) for returning a subset of the list of deployments.
*
*
* @param createTimeRange
* A time range (start and end) for returning a subset of the list of deployments.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDeploymentsRequest withCreateTimeRange(TimeRange createTimeRange) {
setCreateTimeRange(createTimeRange);
return this;
}
/**
*
* An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
*
*
* @param nextToken
* An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
*
*
* @return An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
*
*
* @param nextToken
* An identifier returned from the previous list deployments call. It can be used to return the next set of
* deployments in the list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListDeploymentsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getApplicationName() != null)
sb.append("ApplicationName: ").append(getApplicationName()).append(",");
if (getDeploymentGroupName() != null)
sb.append("DeploymentGroupName: ").append(getDeploymentGroupName()).append(",");
if (getExternalId() != null)
sb.append("ExternalId: ").append(getExternalId()).append(",");
if (getIncludeOnlyStatuses() != null)
sb.append("IncludeOnlyStatuses: ").append(getIncludeOnlyStatuses()).append(",");
if (getCreateTimeRange() != null)
sb.append("CreateTimeRange: ").append(getCreateTimeRange()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListDeploymentsRequest == false)
return false;
ListDeploymentsRequest other = (ListDeploymentsRequest) obj;
if (other.getApplicationName() == null ^ this.getApplicationName() == null)
return false;
if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false)
return false;
if (other.getDeploymentGroupName() == null ^ this.getDeploymentGroupName() == null)
return false;
if (other.getDeploymentGroupName() != null && other.getDeploymentGroupName().equals(this.getDeploymentGroupName()) == false)
return false;
if (other.getExternalId() == null ^ this.getExternalId() == null)
return false;
if (other.getExternalId() != null && other.getExternalId().equals(this.getExternalId()) == false)
return false;
if (other.getIncludeOnlyStatuses() == null ^ this.getIncludeOnlyStatuses() == null)
return false;
if (other.getIncludeOnlyStatuses() != null && other.getIncludeOnlyStatuses().equals(this.getIncludeOnlyStatuses()) == false)
return false;
if (other.getCreateTimeRange() == null ^ this.getCreateTimeRange() == null)
return false;
if (other.getCreateTimeRange() != null && other.getCreateTimeRange().equals(this.getCreateTimeRange()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getApplicationName() == null) ? 0 : getApplicationName().hashCode());
hashCode = prime * hashCode + ((getDeploymentGroupName() == null) ? 0 : getDeploymentGroupName().hashCode());
hashCode = prime * hashCode + ((getExternalId() == null) ? 0 : getExternalId().hashCode());
hashCode = prime * hashCode + ((getIncludeOnlyStatuses() == null) ? 0 : getIncludeOnlyStatuses().hashCode());
hashCode = prime * hashCode + ((getCreateTimeRange() == null) ? 0 : getCreateTimeRange().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListDeploymentsRequest clone() {
return (ListDeploymentsRequest) super.clone();
}
}