Class DescribeTagsRequest
- 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.DescribeTagsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeTagsRequest extends Ec2Request implements ToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeTagsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeTagsRequest.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()
Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token returned from a previous paginated request.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeTagsRequest.Builder>
serializableBuilderClass()
DescribeTagsRequest.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
-
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
.
-
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.
-
key
- The tag key. -
resource-id
- The ID of the resource. -
resource-type
- The resource type (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
tag
:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". -
value
- The tag value.
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.
-
key
- The tag key. -
resource-id
- The ID of the resource. -
resource-type
- The resource type (customer-gateway
|dedicated-host
|dhcp-options
|elastic-ip
|fleet
|fpga-image
|host-reservation
|image
|instance
|internet-gateway
|key-pair
|launch-template
|natgateway
|network-acl
|network-interface
|placement-group
|reserved-instances
|route-table
|security-group
|snapshot
|spot-instances-request
|subnet
|volume
|vpc
|vpc-endpoint
|vpc-endpoint-service
|vpc-peering-connection
|vpn-connection
|vpn-gateway
). -
tag
:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". -
value
- The tag value.
-
-
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
- Returns:
- The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
-
nextToken
public final String nextToken()
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Returns:
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
toBuilder
public DescribeTagsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeTagsRequest.Builder,DescribeTagsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeTagsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeTagsRequest.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
-
-