com.amazonaws.services.ram.model.ListResourcesRequest 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.ram.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 {
/**
*
* Specifies that you want to list only the resource shares that match the following:
*
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
*
*/
private String resourceOwner;
/**
*
* Specifies that you want to list only the resource shares that are associated with the specified principal.
*
*/
private String principal;
/**
*
* Specifies that you want to list only the resource shares that include resources of the specified resource type.
*
*
* For valid values, query the ListResourceTypes operation.
*
*/
private String resourceType;
/**
*
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*
*/
private java.util.List resourceArns;
/**
*
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*
*/
private java.util.List resourceShareArns;
/**
*
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken
* response in the previous request. If you did, it indicates that more output is available. Set this parameter to
* the value provided by the previous call's NextToken response to request the next page of results.
*
*/
private String nextToken;
/**
*
* Specifies the total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
* number you specify, the NextToken response element is returned with a value (not null). Include the
* specified value as the NextToken request parameter in the next call to the operation to get the next
* part of the results. Note that the service might return fewer results than the maximum even when there are more
* results available. You should check NextToken after every operation to ensure that you receive all
* of the results.
*
*/
private Integer maxResults;
/**
*
* Specifies that you want the results to include only resources that have the specified scope.
*
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
*
*/
private String resourceRegionScope;
/**
*
* Specifies that you want to list only the resource shares that match the following:
*
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
*
*
* @param resourceOwner
* Specifies that you want to list only the resource shares that match the following:
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
* @see ResourceOwner
*/
public void setResourceOwner(String resourceOwner) {
this.resourceOwner = resourceOwner;
}
/**
*
* Specifies that you want to list only the resource shares that match the following:
*
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
*
*
* @return Specifies that you want to list only the resource shares that match the following:
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
* @see ResourceOwner
*/
public String getResourceOwner() {
return this.resourceOwner;
}
/**
*
* Specifies that you want to list only the resource shares that match the following:
*
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
*
*
* @param resourceOwner
* Specifies that you want to list only the resource shares that match the following:
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceOwner
*/
public ListResourcesRequest withResourceOwner(String resourceOwner) {
setResourceOwner(resourceOwner);
return this;
}
/**
*
* Specifies that you want to list only the resource shares that match the following:
*
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
*
*
* @param resourceOwner
* Specifies that you want to list only the resource shares that match the following:
*
* -
*
* SELF – resources that your account shares with other accounts
*
*
* -
*
* OTHER-ACCOUNTS – resources that other accounts share with your account
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceOwner
*/
public ListResourcesRequest withResourceOwner(ResourceOwner resourceOwner) {
this.resourceOwner = resourceOwner.toString();
return this;
}
/**
*
* Specifies that you want to list only the resource shares that are associated with the specified principal.
*
*
* @param principal
* Specifies that you want to list only the resource shares that are associated with the specified principal.
*/
public void setPrincipal(String principal) {
this.principal = principal;
}
/**
*
* Specifies that you want to list only the resource shares that are associated with the specified principal.
*
*
* @return Specifies that you want to list only the resource shares that are associated with the specified
* principal.
*/
public String getPrincipal() {
return this.principal;
}
/**
*
* Specifies that you want to list only the resource shares that are associated with the specified principal.
*
*
* @param principal
* Specifies that you want to list only the resource shares that are associated with the specified principal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withPrincipal(String principal) {
setPrincipal(principal);
return this;
}
/**
*
* Specifies that you want to list only the resource shares that include resources of the specified resource type.
*
*
* For valid values, query the ListResourceTypes operation.
*
*
* @param resourceType
* Specifies that you want to list only the resource shares that include resources of the specified resource
* type.
*
* For valid values, query the ListResourceTypes operation.
*/
public void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
/**
*
* Specifies that you want to list only the resource shares that include resources of the specified resource type.
*
*
* For valid values, query the ListResourceTypes operation.
*
*
* @return Specifies that you want to list only the resource shares that include resources of the specified resource
* type.
*
* For valid values, query the ListResourceTypes operation.
*/
public String getResourceType() {
return this.resourceType;
}
/**
*
* Specifies that you want to list only the resource shares that include resources of the specified resource type.
*
*
* For valid values, query the ListResourceTypes operation.
*
*
* @param resourceType
* Specifies that you want to list only the resource shares that include resources of the specified resource
* type.
*
* For valid values, query the ListResourceTypes operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withResourceType(String resourceType) {
setResourceType(resourceType);
return this;
}
/**
*
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*
*
* @return Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*/
public java.util.List getResourceArns() {
return resourceArns;
}
/**
*
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*
*
* @param resourceArns
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*/
public void setResourceArns(java.util.Collection resourceArns) {
if (resourceArns == null) {
this.resourceArns = null;
return;
}
this.resourceArns = new java.util.ArrayList(resourceArns);
}
/**
*
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourceArns(java.util.Collection)} or {@link #withResourceArns(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param resourceArns
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withResourceArns(String... resourceArns) {
if (this.resourceArns == null) {
setResourceArns(new java.util.ArrayList(resourceArns.length));
}
for (String ele : resourceArns) {
this.resourceArns.add(ele);
}
return this;
}
/**
*
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
*
*
* @param resourceArns
* Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names
* (ARNs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withResourceArns(java.util.Collection resourceArns) {
setResourceArns(resourceArns);
return this;
}
/**
*
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*
*
* @return Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*/
public java.util.List getResourceShareArns() {
return resourceShareArns;
}
/**
*
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*
*
* @param resourceShareArns
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*/
public void setResourceShareArns(java.util.Collection resourceShareArns) {
if (resourceShareArns == null) {
this.resourceShareArns = null;
return;
}
this.resourceShareArns = new java.util.ArrayList(resourceShareArns);
}
/**
*
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourceShareArns(java.util.Collection)} or {@link #withResourceShareArns(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param resourceShareArns
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withResourceShareArns(String... resourceShareArns) {
if (this.resourceShareArns == null) {
setResourceShareArns(new java.util.ArrayList(resourceShareArns.length));
}
for (String ele : resourceShareArns) {
this.resourceShareArns.add(ele);
}
return this;
}
/**
*
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
*
*
* @param resourceShareArns
* Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names
* (ARNs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withResourceShareArns(java.util.Collection resourceShareArns) {
setResourceShareArns(resourceShareArns);
return this;
}
/**
*
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken
* response in the previous request. If you did, it indicates that more output is available. Set this parameter to
* the value provided by the previous call's NextToken response to request the next page of results.
*
*
* @param nextToken
* Specifies that you want to receive the next page of results. Valid only if you received a
* NextToken response in the previous request. If you did, it indicates that more output is
* available. Set this parameter to the value provided by the previous call's NextToken response
* to request the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken
* response in the previous request. If you did, it indicates that more output is available. Set this parameter to
* the value provided by the previous call's NextToken response to request the next page of results.
*
*
* @return Specifies that you want to receive the next page of results. Valid only if you received a
* NextToken response in the previous request. If you did, it indicates that more output is
* available. Set this parameter to the value provided by the previous call's NextToken
* response to request the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken
* response in the previous request. If you did, it indicates that more output is available. Set this parameter to
* the value provided by the previous call's NextToken response to request the next page of results.
*
*
* @param nextToken
* Specifies that you want to receive the next page of results. Valid only if you received a
* NextToken response in the previous request. If you did, it indicates that more output is
* available. Set this parameter to the value provided by the previous call's NextToken response
* to request the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Specifies the total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
* number you specify, the NextToken response element is returned with a value (not null). Include the
* specified value as the NextToken request parameter in the next call to the operation to get the next
* part of the results. Note that the service might return fewer results than the maximum even when there are more
* results available. You should check NextToken after every operation to ensure that you receive all
* of the results.
*
*
* @param maxResults
* Specifies the total number of results that you want included on each page of the response. If you do not
* include this parameter, it defaults to a value that is specific to the operation. If additional items
* exist beyond the number you specify, the NextToken response element is returned with a value
* (not null). Include the specified value as the NextToken request parameter in the next call
* to the operation to get the next part of the results. Note that the service might return fewer results
* than the maximum even when there are more results available. You should check NextToken after
* every operation to ensure that you receive all of the results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* Specifies the total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
* number you specify, the NextToken response element is returned with a value (not null). Include the
* specified value as the NextToken request parameter in the next call to the operation to get the next
* part of the results. Note that the service might return fewer results than the maximum even when there are more
* results available. You should check NextToken after every operation to ensure that you receive all
* of the results.
*
*
* @return Specifies the total number of results that you want included on each page of the response. If you do not
* include this parameter, it defaults to a value that is specific to the operation. If additional items
* exist beyond the number you specify, the NextToken response element is returned with a value
* (not null). Include the specified value as the NextToken request parameter in the next call
* to the operation to get the next part of the results. Note that the service might return fewer results
* than the maximum even when there are more results available. You should check NextToken
* after every operation to ensure that you receive all of the results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* Specifies the total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
* number you specify, the NextToken response element is returned with a value (not null). Include the
* specified value as the NextToken request parameter in the next call to the operation to get the next
* part of the results. Note that the service might return fewer results than the maximum even when there are more
* results available. You should check NextToken after every operation to ensure that you receive all
* of the results.
*
*
* @param maxResults
* Specifies the total number of results that you want included on each page of the response. If you do not
* include this parameter, it defaults to a value that is specific to the operation. If additional items
* exist beyond the number you specify, the NextToken response element is returned with a value
* (not null). Include the specified value as the NextToken request parameter in the next call
* to the operation to get the next part of the results. Note that the service might return fewer results
* than the maximum even when there are more results available. You should check NextToken after
* every operation to ensure that you receive all of the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListResourcesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* Specifies that you want the results to include only resources that have the specified scope.
*
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
*
*
* @param resourceRegionScope
* Specifies that you want the results to include only resources that have the specified scope.
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
* @see ResourceRegionScopeFilter
*/
public void setResourceRegionScope(String resourceRegionScope) {
this.resourceRegionScope = resourceRegionScope;
}
/**
*
* Specifies that you want the results to include only resources that have the specified scope.
*
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
*
*
* @return Specifies that you want the results to include only resources that have the specified scope.
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
* @see ResourceRegionScopeFilter
*/
public String getResourceRegionScope() {
return this.resourceRegionScope;
}
/**
*
* Specifies that you want the results to include only resources that have the specified scope.
*
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
*
*
* @param resourceRegionScope
* Specifies that you want the results to include only resources that have the specified scope.
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceRegionScopeFilter
*/
public ListResourcesRequest withResourceRegionScope(String resourceRegionScope) {
setResourceRegionScope(resourceRegionScope);
return this;
}
/**
*
* Specifies that you want the results to include only resources that have the specified scope.
*
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
*
*
* @param resourceRegionScope
* Specifies that you want the results to include only resources that have the specified scope.
*
* -
*
* ALL – the results include both global and regional resources or resource types.
*
*
* -
*
* GLOBAL – the results include only global resources or resource types.
*
*
* -
*
* REGIONAL – the results include only regional resources or resource types.
*
*
*
*
* The default value is ALL.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceRegionScopeFilter
*/
public ListResourcesRequest withResourceRegionScope(ResourceRegionScopeFilter resourceRegionScope) {
this.resourceRegionScope = resourceRegionScope.toString();
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 (getResourceOwner() != null)
sb.append("ResourceOwner: ").append(getResourceOwner()).append(",");
if (getPrincipal() != null)
sb.append("Principal: ").append(getPrincipal()).append(",");
if (getResourceType() != null)
sb.append("ResourceType: ").append(getResourceType()).append(",");
if (getResourceArns() != null)
sb.append("ResourceArns: ").append(getResourceArns()).append(",");
if (getResourceShareArns() != null)
sb.append("ResourceShareArns: ").append(getResourceShareArns()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getResourceRegionScope() != null)
sb.append("ResourceRegionScope: ").append(getResourceRegionScope());
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.getResourceOwner() == null ^ this.getResourceOwner() == null)
return false;
if (other.getResourceOwner() != null && other.getResourceOwner().equals(this.getResourceOwner()) == false)
return false;
if (other.getPrincipal() == null ^ this.getPrincipal() == null)
return false;
if (other.getPrincipal() != null && other.getPrincipal().equals(this.getPrincipal()) == false)
return false;
if (other.getResourceType() == null ^ this.getResourceType() == null)
return false;
if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == false)
return false;
if (other.getResourceArns() == null ^ this.getResourceArns() == null)
return false;
if (other.getResourceArns() != null && other.getResourceArns().equals(this.getResourceArns()) == false)
return false;
if (other.getResourceShareArns() == null ^ this.getResourceShareArns() == null)
return false;
if (other.getResourceShareArns() != null && other.getResourceShareArns().equals(this.getResourceShareArns()) == 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.getResourceRegionScope() == null ^ this.getResourceRegionScope() == null)
return false;
if (other.getResourceRegionScope() != null && other.getResourceRegionScope().equals(this.getResourceRegionScope()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getResourceOwner() == null) ? 0 : getResourceOwner().hashCode());
hashCode = prime * hashCode + ((getPrincipal() == null) ? 0 : getPrincipal().hashCode());
hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode());
hashCode = prime * hashCode + ((getResourceArns() == null) ? 0 : getResourceArns().hashCode());
hashCode = prime * hashCode + ((getResourceShareArns() == null) ? 0 : getResourceShareArns().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getResourceRegionScope() == null) ? 0 : getResourceRegionScope().hashCode());
return hashCode;
}
@Override
public ListResourcesRequest clone() {
return (ListResourcesRequest) super.clone();
}
}