Class DescribeRegionsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeRegionsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeRegionsRequest.Builder,DescribeRegionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeRegionsRequest extends Ec2Request implements ToCopyableBuilder<DescribeRegionsRequest.Builder,DescribeRegionsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeRegionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
allRegions()
Indicates whether to display all Regions, including Regions that are disabled for your account.static DescribeRegionsRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
The filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasRegionNames()
For responses, this returns true if the service returned a value for the RegionNames property.List<String>
regionNames()
The names of the Regions.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeRegionsRequest.Builder>
serializableBuilderClass()
DescribeRegionsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final List<Filter> filters()
The filters.
-
endpoint
- The endpoint of the Region (for example,ec2.us-east-1.amazonaws.com
). -
opt-in-status
- The opt-in status of the Region (opt-in-not-required
|opted-in
|not-opted-in
). -
region-name
- The name of the Region (for example,us-east-1
).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- The filters.
-
endpoint
- The endpoint of the Region (for example,ec2.us-east-1.amazonaws.com
). -
opt-in-status
- The opt-in status of the Region (opt-in-not-required
|opted-in
|not-opted-in
). -
region-name
- The name of the Region (for example,us-east-1
).
-
-
-
hasRegionNames
public final boolean hasRegionNames()
For responses, this returns true if the service returned a value for the RegionNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
regionNames
public final List<String> regionNames()
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRegionNames()
method.- Returns:
- The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
allRegions
public final Boolean allRegions()
Indicates whether to display all Regions, including Regions that are disabled for your account.
- Returns:
- Indicates whether to display all Regions, including Regions that are disabled for your account.
-
toBuilder
public DescribeRegionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeRegionsRequest.Builder,DescribeRegionsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeRegionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeRegionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-