com.amazonaws.services.redshift.model.DescribeNodeConfigurationOptionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-redshift Show documentation
/*
* 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.redshift.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 DescribeNodeConfigurationOptionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*/
private String actionType;
/**
*
* The identifier of the cluster to evaluate for possible node configurations.
*
*/
private String clusterIdentifier;
/**
*
* The identifier of the snapshot to evaluate for possible node configurations.
*
*/
private String snapshotIdentifier;
/**
*
* The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
*
*/
private String snapshotArn;
/**
*
* The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you
* do not own, optional if you own the snapshot.
*
*/
private String ownerAccount;
/**
*
* A set of name, operator, and value items to filter the results.
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords
, Amazon
* Web Services returns a value in the Marker
field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker
parameter and retrying the
* request.
*
*/
private String marker;
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords
value, a value is returned in a marker
field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
*
*/
private Integer maxRecords;
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*
* @param actionType
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get
* configuration combinations for elastic resize based on an existing cluster.
* @see ActionType
*/
public void setActionType(String actionType) {
this.actionType = actionType;
}
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*
* @return The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get
* configuration combinations for elastic resize based on an existing cluster.
* @see ActionType
*/
public String getActionType() {
return this.actionType;
}
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*
* @param actionType
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get
* configuration combinations for elastic resize based on an existing cluster.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
public DescribeNodeConfigurationOptionsRequest withActionType(String actionType) {
setActionType(actionType);
return this;
}
/**
*
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration
* combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations
* based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic
* resize based on an existing cluster.
*
*
* @param actionType
* The action type to evaluate for possible node configurations. Specify "restore-cluster" to get
* configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get
* configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get
* configuration combinations for elastic resize based on an existing cluster.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionType
*/
public DescribeNodeConfigurationOptionsRequest withActionType(ActionType actionType) {
this.actionType = actionType.toString();
return this;
}
/**
*
* The identifier of the cluster to evaluate for possible node configurations.
*
*
* @param clusterIdentifier
* The identifier of the cluster to evaluate for possible node configurations.
*/
public void setClusterIdentifier(String clusterIdentifier) {
this.clusterIdentifier = clusterIdentifier;
}
/**
*
* The identifier of the cluster to evaluate for possible node configurations.
*
*
* @return The identifier of the cluster to evaluate for possible node configurations.
*/
public String getClusterIdentifier() {
return this.clusterIdentifier;
}
/**
*
* The identifier of the cluster to evaluate for possible node configurations.
*
*
* @param clusterIdentifier
* The identifier of the cluster to evaluate for possible node configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withClusterIdentifier(String clusterIdentifier) {
setClusterIdentifier(clusterIdentifier);
return this;
}
/**
*
* The identifier of the snapshot to evaluate for possible node configurations.
*
*
* @param snapshotIdentifier
* The identifier of the snapshot to evaluate for possible node configurations.
*/
public void setSnapshotIdentifier(String snapshotIdentifier) {
this.snapshotIdentifier = snapshotIdentifier;
}
/**
*
* The identifier of the snapshot to evaluate for possible node configurations.
*
*
* @return The identifier of the snapshot to evaluate for possible node configurations.
*/
public String getSnapshotIdentifier() {
return this.snapshotIdentifier;
}
/**
*
* The identifier of the snapshot to evaluate for possible node configurations.
*
*
* @param snapshotIdentifier
* The identifier of the snapshot to evaluate for possible node configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withSnapshotIdentifier(String snapshotIdentifier) {
setSnapshotIdentifier(snapshotIdentifier);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
*
*
* @param snapshotArn
* The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
*/
public void setSnapshotArn(String snapshotArn) {
this.snapshotArn = snapshotArn;
}
/**
*
* The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
*
*
* @return The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node
* configuration.
*/
public String getSnapshotArn() {
return this.snapshotArn;
}
/**
*
* The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
*
*
* @param snapshotArn
* The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withSnapshotArn(String snapshotArn) {
setSnapshotArn(snapshotArn);
return this;
}
/**
*
* The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you
* do not own, optional if you own the snapshot.
*
*
* @param ownerAccount
* The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a
* snapshot you do not own, optional if you own the snapshot.
*/
public void setOwnerAccount(String ownerAccount) {
this.ownerAccount = ownerAccount;
}
/**
*
* The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you
* do not own, optional if you own the snapshot.
*
*
* @return The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a
* snapshot you do not own, optional if you own the snapshot.
*/
public String getOwnerAccount() {
return this.ownerAccount;
}
/**
*
* The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you
* do not own, optional if you own the snapshot.
*
*
* @param ownerAccount
* The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a
* snapshot you do not own, optional if you own the snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withOwnerAccount(String ownerAccount) {
setOwnerAccount(ownerAccount);
return this;
}
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* @return A set of name, operator, and value items to filter the results.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* @param filters
* A set of name, operator, and value items to filter the results.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* 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
* A set of name, operator, and value items to filter the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withFilters(NodeConfigurationOptionsFilter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (NodeConfigurationOptionsFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* A set of name, operator, and value items to filter the results.
*
*
* @param filters
* A set of name, operator, and value items to filter the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords
, Amazon
* Web Services returns a value in the Marker
field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker
parameter and retrying the
* request.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeNodeConfigurationOptions request exceed the value specified in
* MaxRecords
, Amazon Web Services returns a value in the Marker
field of the
* response. You can retrieve the next set of response records by providing the returned marker value in the
* Marker
parameter and retrying the request.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords
, Amazon
* Web Services returns a value in the Marker
field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker
parameter and retrying the
* request.
*
*
* @return An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeNodeConfigurationOptions request exceed the value specified in
* MaxRecords
, Amazon Web Services returns a value in the Marker
field of the
* response. You can retrieve the next set of response records by providing the returned marker value in the
* Marker
parameter and retrying the request.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords
, Amazon
* Web Services returns a value in the Marker
field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker
parameter and retrying the
* request.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeNodeConfigurationOptions request exceed the value specified in
* MaxRecords
, Amazon Web Services returns a value in the Marker
field of the
* response. You can retrieve the next set of response records by providing the returned marker value in the
* Marker
parameter and retrying the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords
value, a value is returned in a marker
field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
*
*
* @param maxRecords
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords
value, a value is returned in a marker
field of
* the response. You can retrieve the next set of records by retrying the command with the returned marker
* value.
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords
value, a value is returned in a marker
field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
*
*
* @return The maximum number of response records to return in each call. If the number of remaining response
* records exceeds the specified MaxRecords
value, a value is returned in a marker
* field of the response. You can retrieve the next set of records by retrying the command with the returned
* marker value.
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords
value, a value is returned in a marker
field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
*
*
* @param maxRecords
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords
value, a value is returned in a marker
field of
* the response. You can retrieve the next set of records by retrying the command with the returned marker
* value.
*
* Default: 500
*
*
* Constraints: minimum 100, maximum 500.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNodeConfigurationOptionsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
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 (getActionType() != null)
sb.append("ActionType: ").append(getActionType()).append(",");
if (getClusterIdentifier() != null)
sb.append("ClusterIdentifier: ").append(getClusterIdentifier()).append(",");
if (getSnapshotIdentifier() != null)
sb.append("SnapshotIdentifier: ").append(getSnapshotIdentifier()).append(",");
if (getSnapshotArn() != null)
sb.append("SnapshotArn: ").append(getSnapshotArn()).append(",");
if (getOwnerAccount() != null)
sb.append("OwnerAccount: ").append(getOwnerAccount()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeNodeConfigurationOptionsRequest == false)
return false;
DescribeNodeConfigurationOptionsRequest other = (DescribeNodeConfigurationOptionsRequest) obj;
if (other.getActionType() == null ^ this.getActionType() == null)
return false;
if (other.getActionType() != null && other.getActionType().equals(this.getActionType()) == false)
return false;
if (other.getClusterIdentifier() == null ^ this.getClusterIdentifier() == null)
return false;
if (other.getClusterIdentifier() != null && other.getClusterIdentifier().equals(this.getClusterIdentifier()) == false)
return false;
if (other.getSnapshotIdentifier() == null ^ this.getSnapshotIdentifier() == null)
return false;
if (other.getSnapshotIdentifier() != null && other.getSnapshotIdentifier().equals(this.getSnapshotIdentifier()) == false)
return false;
if (other.getSnapshotArn() == null ^ this.getSnapshotArn() == null)
return false;
if (other.getSnapshotArn() != null && other.getSnapshotArn().equals(this.getSnapshotArn()) == false)
return false;
if (other.getOwnerAccount() == null ^ this.getOwnerAccount() == null)
return false;
if (other.getOwnerAccount() != null && other.getOwnerAccount().equals(this.getOwnerAccount()) == 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.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getActionType() == null) ? 0 : getActionType().hashCode());
hashCode = prime * hashCode + ((getClusterIdentifier() == null) ? 0 : getClusterIdentifier().hashCode());
hashCode = prime * hashCode + ((getSnapshotIdentifier() == null) ? 0 : getSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getSnapshotArn() == null) ? 0 : getSnapshotArn().hashCode());
hashCode = prime * hashCode + ((getOwnerAccount() == null) ? 0 : getOwnerAccount().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
return hashCode;
}
@Override
public DescribeNodeConfigurationOptionsRequest clone() {
return (DescribeNodeConfigurationOptionsRequest) super.clone();
}
}