com.amazonaws.services.account.model.ListRegionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-account 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.account.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 ListRegionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify
* with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the
* identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a
* member account in the same organization. The organization must have all
* features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated
* admin account assigned.
*
*
*
* The management account can't specify its own AccountId. It must call the operation in standalone
* context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this parameter.
* Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or
* modify.
*
*/
private String accountId;
/**
*
* The total number of items to return in the command’s output. If the total number of items available is more than
* the value specified, a NextToken is provided in the command’s output. To resume pagination, provide
* the NextToken value in the starting-token argument of a subsequent command. Do not use
* the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples,
* see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*/
private Integer maxResults;
/**
*
* A token used to specify where to start paginating. This is the NextToken from a previously truncated
* response. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*/
private String nextToken;
/**
*
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list
* of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions
* with a Region status of ENABLING.
*
*/
private java.util.List regionOptStatusContains;
/**
*
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify
* with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the
* identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a
* member account in the same organization. The organization must have all
* features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated
* admin account assigned.
*
*
*
* The management account can't specify its own AccountId. It must call the operation in standalone
* context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this parameter.
* Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or
* modify.
*
*
* @param accountId
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or
* modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services
* account of the identity used to call the operation. To use this parameter, the caller must be an identity
* in the organization's management account or a delegated administrator account. The specified account ID must
* be a member account in the same organization. The organization must have all
* features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated admin account assigned.
*
* The management account can't specify its own AccountId. It must call the operation in
* standalone context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this
* parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish
* to retrieve or modify.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify
* with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the
* identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a
* member account in the same organization. The organization must have all
* features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated
* admin account assigned.
*
*
*
* The management account can't specify its own AccountId. It must call the operation in standalone
* context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this parameter.
* Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or
* modify.
*
*
* @return Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or
* modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services
* account of the identity used to call the operation. To use this parameter, the caller must be an identity
* in the organization's management account or a delegated administrator account. The specified account ID
* must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated admin account assigned.
*
* The management account can't specify its own AccountId. It must call the operation in
* standalone context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this
* parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish
* to retrieve or modify.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify
* with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the
* identity used to call the operation. To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account. The specified account ID must be a
* member account in the same organization. The organization must have all
* features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated
* admin account assigned.
*
*
*
* The management account can't specify its own AccountId. It must call the operation in standalone
* context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this parameter.
* Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or
* modify.
*
*
* @param accountId
* Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or
* modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services
* account of the identity used to call the operation. To use this parameter, the caller must be an identity
* in the organization's management account or a delegated administrator account. The specified account ID must
* be a member account in the same organization. The organization must have all
* features enabled, and the organization must have trusted
* access enabled for the Account Management service, and optionally a delegated admin account assigned.
*
* The management account can't specify its own AccountId. It must call the operation in
* standalone context by not including the AccountId parameter.
*
*
*
* To call this operation on an account that is not a member of an organization, don't specify this
* parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish
* to retrieve or modify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListRegionsRequest withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* The total number of items to return in the command’s output. If the total number of items available is more than
* the value specified, a NextToken is provided in the command’s output. To resume pagination, provide
* the NextToken value in the starting-token argument of a subsequent command. Do not use
* the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples,
* see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*
* @param maxResults
* The total number of items to return in the command’s output. If the total number of items available is
* more than the value specified, a NextToken is provided in the command’s output. To resume
* pagination, provide the NextToken value in the starting-token argument of a
* subsequent command. Do not use the NextToken response element directly outside of the Amazon
* Web Services CLI. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The total number of items to return in the command’s output. If the total number of items available is more than
* the value specified, a NextToken is provided in the command’s output. To resume pagination, provide
* the NextToken value in the starting-token argument of a subsequent command. Do not use
* the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples,
* see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*
* @return The total number of items to return in the command’s output. If the total number of items available is
* more than the value specified, a NextToken is provided in the command’s output. To resume
* pagination, provide the NextToken value in the starting-token argument of a
* subsequent command. Do not use the NextToken response element directly outside of the Amazon
* Web Services CLI. For usage examples, see Pagination in the Amazon
* Web Services Command Line Interface User Guide.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The total number of items to return in the command’s output. If the total number of items available is more than
* the value specified, a NextToken is provided in the command’s output. To resume pagination, provide
* the NextToken value in the starting-token argument of a subsequent command. Do not use
* the NextToken response element directly outside of the Amazon Web Services CLI. For usage examples,
* see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*
* @param maxResults
* The total number of items to return in the command’s output. If the total number of items available is
* more than the value specified, a NextToken is provided in the command’s output. To resume
* pagination, provide the NextToken value in the starting-token argument of a
* subsequent command. Do not use the NextToken response element directly outside of the Amazon
* Web Services CLI. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListRegionsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* A token used to specify where to start paginating. This is the NextToken from a previously truncated
* response. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*
* @param nextToken
* A token used to specify where to start paginating. This is the NextToken from a previously
* truncated response. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token used to specify where to start paginating. This is the NextToken from a previously truncated
* response. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*
* @return A token used to specify where to start paginating. This is the NextToken from a previously
* truncated response. For usage examples, see Pagination in the Amazon
* Web Services Command Line Interface User Guide.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token used to specify where to start paginating. This is the NextToken from a previously truncated
* response. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
*
*
* @param nextToken
* A token used to specify where to start paginating. This is the NextToken from a previously
* truncated response. For usage examples, see Pagination in the Amazon Web
* Services Command Line Interface User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListRegionsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list
* of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions
* with a Region status of ENABLING.
*
*
* @return A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter
* the list of Regions for a given account. For example, passing in a value of ENABLING will only return a
* list of Regions with a Region status of ENABLING.
* @see RegionOptStatus
*/
public java.util.List getRegionOptStatusContains() {
return regionOptStatusContains;
}
/**
*
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list
* of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions
* with a Region status of ENABLING.
*
*
* @param regionOptStatusContains
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter
* the list of Regions for a given account. For example, passing in a value of ENABLING will only return a
* list of Regions with a Region status of ENABLING.
* @see RegionOptStatus
*/
public void setRegionOptStatusContains(java.util.Collection regionOptStatusContains) {
if (regionOptStatusContains == null) {
this.regionOptStatusContains = null;
return;
}
this.regionOptStatusContains = new java.util.ArrayList(regionOptStatusContains);
}
/**
*
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list
* of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions
* with a Region status of ENABLING.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegionOptStatusContains(java.util.Collection)} or
* {@link #withRegionOptStatusContains(java.util.Collection)} if you want to override the existing values.
*
*
* @param regionOptStatusContains
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter
* the list of Regions for a given account. For example, passing in a value of ENABLING will only return a
* list of Regions with a Region status of ENABLING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RegionOptStatus
*/
public ListRegionsRequest withRegionOptStatusContains(String... regionOptStatusContains) {
if (this.regionOptStatusContains == null) {
setRegionOptStatusContains(new java.util.ArrayList(regionOptStatusContains.length));
}
for (String ele : regionOptStatusContains) {
this.regionOptStatusContains.add(ele);
}
return this;
}
/**
*
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list
* of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions
* with a Region status of ENABLING.
*
*
* @param regionOptStatusContains
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter
* the list of Regions for a given account. For example, passing in a value of ENABLING will only return a
* list of Regions with a Region status of ENABLING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RegionOptStatus
*/
public ListRegionsRequest withRegionOptStatusContains(java.util.Collection regionOptStatusContains) {
setRegionOptStatusContains(regionOptStatusContains);
return this;
}
/**
*
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list
* of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions
* with a Region status of ENABLING.
*
*
* @param regionOptStatusContains
* A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter
* the list of Regions for a given account. For example, passing in a value of ENABLING will only return a
* list of Regions with a Region status of ENABLING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RegionOptStatus
*/
public ListRegionsRequest withRegionOptStatusContains(RegionOptStatus... regionOptStatusContains) {
java.util.ArrayList regionOptStatusContainsCopy = new java.util.ArrayList(regionOptStatusContains.length);
for (RegionOptStatus value : regionOptStatusContains) {
regionOptStatusContainsCopy.add(value.toString());
}
if (getRegionOptStatusContains() == null) {
setRegionOptStatusContains(regionOptStatusContainsCopy);
} else {
getRegionOptStatusContains().addAll(regionOptStatusContainsCopy);
}
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 (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getRegionOptStatusContains() != null)
sb.append("RegionOptStatusContains: ").append(getRegionOptStatusContains());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListRegionsRequest == false)
return false;
ListRegionsRequest other = (ListRegionsRequest) obj;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == 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.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getRegionOptStatusContains() == null ^ this.getRegionOptStatusContains() == null)
return false;
if (other.getRegionOptStatusContains() != null && other.getRegionOptStatusContains().equals(this.getRegionOptStatusContains()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getRegionOptStatusContains() == null) ? 0 : getRegionOptStatusContains().hashCode());
return hashCode;
}
@Override
public ListRegionsRequest clone() {
return (ListRegionsRequest) super.clone();
}
}