com.amazonaws.services.ram.model.ListPendingInvitationResourcesRequest 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 ListPendingInvitationResourcesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the
* invitation.
*
*/
private String resourceShareInvitationArn;
/**
*
* 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 the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the
* invitation.
*
*
* @param resourceShareInvitationArn
* Specifies the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN
* of the invitation.
*/
public void setResourceShareInvitationArn(String resourceShareInvitationArn) {
this.resourceShareInvitationArn = resourceShareInvitationArn;
}
/**
*
* Specifies the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the
* invitation.
*
*
* @return Specifies the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN
* of the invitation.
*/
public String getResourceShareInvitationArn() {
return this.resourceShareInvitationArn;
}
/**
*
* Specifies the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the
* invitation.
*
*
* @param resourceShareInvitationArn
* Specifies the Amazon
* Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN
* of the invitation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPendingInvitationResourcesRequest withResourceShareInvitationArn(String resourceShareInvitationArn) {
setResourceShareInvitationArn(resourceShareInvitationArn);
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 ListPendingInvitationResourcesRequest 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 ListPendingInvitationResourcesRequest 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 ListPendingInvitationResourcesRequest 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 ListPendingInvitationResourcesRequest 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 (getResourceShareInvitationArn() != null)
sb.append("ResourceShareInvitationArn: ").append(getResourceShareInvitationArn()).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 ListPendingInvitationResourcesRequest == false)
return false;
ListPendingInvitationResourcesRequest other = (ListPendingInvitationResourcesRequest) obj;
if (other.getResourceShareInvitationArn() == null ^ this.getResourceShareInvitationArn() == null)
return false;
if (other.getResourceShareInvitationArn() != null && other.getResourceShareInvitationArn().equals(this.getResourceShareInvitationArn()) == 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 + ((getResourceShareInvitationArn() == null) ? 0 : getResourceShareInvitationArn().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 ListPendingInvitationResourcesRequest clone() {
return (ListPendingInvitationResourcesRequest) super.clone();
}
}