com.amazonaws.services.cloudcontrolapi.model.ListResourcesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudcontrolapi Show documentation
/*
* Copyright 2018-2023 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.cloudcontrolapi.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 ListResourcesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the resource type.
*
*/
private String typeName;
/**
*
* For private resource types, the type version to use in this resource operation. If you do not specify a resource
* version, CloudFormation uses the default version.
*
*/
private String typeVersionId;
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when
* performing this resource operation. The role specified must have the permissions required for this operation. The
* necessary permissions for each event handler are defined in the
* handlers
* section of the resource type
* definition schema.
*
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services
* user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
*
*/
private String roleArn;
/**
*
* If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this action
* again and assign that token to the request object's NextToken parameter. If there are no remaining
* results, the previous response object's NextToken parameter is set to null.
*
*/
private String nextToken;
/**
*
* Reserved.
*
*/
private Integer maxResults;
/**
*
* The resource model to use to select the resources to return.
*
*/
private String resourceModel;
/**
*
* The name of the resource type.
*
*
* @param typeName
* The name of the resource type.
*/
public void setTypeName(String typeName) {
this.typeName = typeName;
}
/**
*
* The name of the resource type.
*
*
* @return The name of the resource type.
*/
public String getTypeName() {
return this.typeName;
}
/**
*
* The name of the resource type.
*
*
* @param typeName
* The name of the resource type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withTypeName(String typeName) {
setTypeName(typeName);
return this;
}
/**
*
* For private resource types, the type version to use in this resource operation. If you do not specify a resource
* version, CloudFormation uses the default version.
*
*
* @param typeVersionId
* For private resource types, the type version to use in this resource operation. If you do not specify a
* resource version, CloudFormation uses the default version.
*/
public void setTypeVersionId(String typeVersionId) {
this.typeVersionId = typeVersionId;
}
/**
*
* For private resource types, the type version to use in this resource operation. If you do not specify a resource
* version, CloudFormation uses the default version.
*
*
* @return For private resource types, the type version to use in this resource operation. If you do not specify a
* resource version, CloudFormation uses the default version.
*/
public String getTypeVersionId() {
return this.typeVersionId;
}
/**
*
* For private resource types, the type version to use in this resource operation. If you do not specify a resource
* version, CloudFormation uses the default version.
*
*
* @param typeVersionId
* For private resource types, the type version to use in this resource operation. If you do not specify a
* resource version, CloudFormation uses the default version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withTypeVersionId(String typeVersionId) {
setTypeVersionId(typeVersionId);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when
* performing this resource operation. The role specified must have the permissions required for this operation. The
* necessary permissions for each event handler are defined in the
* handlers
* section of the resource type
* definition schema.
*
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services
* user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to
* use when performing this resource operation. The role specified must have the permissions required for
* this operation. The necessary permissions for each event handler are defined in the
* handlers
* section of the resource
* type definition schema.
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web
* Services user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when
* performing this resource operation. The role specified must have the permissions required for this operation. The
* necessary permissions for each event handler are defined in the
* handlers
* section of the resource type
* definition schema.
*
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services
* user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
*
*
* @return The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to
* use when performing this resource operation. The role specified must have the permissions required for
* this operation. The necessary permissions for each event handler are defined in the
* handlers
* section of the resource
* type definition schema.
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web
* Services user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when
* performing this resource operation. The role specified must have the permissions required for this operation. The
* necessary permissions for each event handler are defined in the
* handlers
* section of the resource type
* definition schema.
*
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services
* user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to
* use when performing this resource operation. The role specified must have the permissions required for
* this operation. The necessary permissions for each event handler are defined in the
* handlers
* section of the resource
* type definition schema.
*
* If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web
* Services user credentials.
*
*
* For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this action
* again and assign that token to the request object's NextToken parameter. If there are no remaining
* results, the previous response object's NextToken parameter is set to null.
*
*
* @param nextToken
* If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this
* action again and assign that token to the request object's NextToken parameter. If there are
* no remaining results, the previous response object's NextToken parameter is set to
* null.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this action
* again and assign that token to the request object's NextToken parameter. If there are no remaining
* results, the previous response object's NextToken parameter is set to null.
*
*
* @return If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this
* action again and assign that token to the request object's NextToken parameter. If there are
* no remaining results, the previous response object's NextToken parameter is set to
* null.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this action
* again and assign that token to the request object's NextToken parameter. If there are no remaining
* results, the previous response object's NextToken parameter is set to null.
*
*
* @param nextToken
* If the previous paginated request didn't return all of the remaining results, the response object's
* NextToken parameter value is set to a token. To retrieve the next set of results, call this
* action again and assign that token to the request object's NextToken parameter. If there are
* no remaining results, the previous response object's NextToken parameter is set to
* null.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Reserved.
*
*
* @param maxResults
* Reserved.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* Reserved.
*
*
* @return Reserved.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* Reserved.
*
*
* @param maxResults
* Reserved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The resource model to use to select the resources to return.
*
*
* @param resourceModel
* The resource model to use to select the resources to return.
*/
public void setResourceModel(String resourceModel) {
this.resourceModel = resourceModel;
}
/**
*
* The resource model to use to select the resources to return.
*
*
* @return The resource model to use to select the resources to return.
*/
public String getResourceModel() {
return this.resourceModel;
}
/**
*
* The resource model to use to select the resources to return.
*
*
* @param resourceModel
* The resource model to use to select the resources to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withResourceModel(String resourceModel) {
setResourceModel(resourceModel);
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 (getTypeName() != null)
sb.append("TypeName: ").append(getTypeName()).append(",");
if (getTypeVersionId() != null)
sb.append("TypeVersionId: ").append(getTypeVersionId()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getResourceModel() != null)
sb.append("ResourceModel: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListResourcesRequest == false)
return false;
ListResourcesRequest other = (ListResourcesRequest) obj;
if (other.getTypeName() == null ^ this.getTypeName() == null)
return false;
if (other.getTypeName() != null && other.getTypeName().equals(this.getTypeName()) == false)
return false;
if (other.getTypeVersionId() == null ^ this.getTypeVersionId() == null)
return false;
if (other.getTypeVersionId() != null && other.getTypeVersionId().equals(this.getTypeVersionId()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getResourceModel() == null ^ this.getResourceModel() == null)
return false;
if (other.getResourceModel() != null && other.getResourceModel().equals(this.getResourceModel()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTypeName() == null) ? 0 : getTypeName().hashCode());
hashCode = prime * hashCode + ((getTypeVersionId() == null) ? 0 : getTypeVersionId().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getResourceModel() == null) ? 0 : getResourceModel().hashCode());
return hashCode;
}
@Override
public ListResourcesRequest clone() {
return (ListResourcesRequest) super.clone();
}
}