Class DescribeVpcEndpointsRequest
- 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.DescribeVpcEndpointsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeVpcEndpointsRequest.Builder,DescribeVpcEndpointsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeVpcEndpointsRequest extends Ec2Request implements ToCopyableBuilder<DescribeVpcEndpointsRequest.Builder,DescribeVpcEndpointsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeVpcEndpointsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeVpcEndpointsRequest.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
hasVpcEndpointIds()
For responses, this returns true if the service returned a value for the VpcEndpointIds property.Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token for the next set of items to return.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeVpcEndpointsRequest.Builder>
serializableBuilderClass()
DescribeVpcEndpointsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
vpcEndpointIds()
The IDs of the VPC endpoints.-
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
.
-
hasVpcEndpointIds
public final boolean hasVpcEndpointIds()
For responses, this returns true if the service returned a value for the VpcEndpointIds 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.
-
vpcEndpointIds
public final List<String> vpcEndpointIds()
The IDs of the VPC endpoints.
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
hasVpcEndpointIds()
method.- Returns:
- The IDs of the VPC endpoints.
-
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.
-
ip-address-type
- The IP address type (ipv4
|ipv6
). -
service-name
- The name of the service. -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
vpc-id
- The ID of the VPC in which the endpoint resides. -
vpc-endpoint-id
- The ID of the endpoint. -
vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|pending
|available
|deleting
|deleted
|rejected
|failed
). -
vpc-endpoint-type
- The type of VPC endpoint (Interface
|Gateway
|GatewayLoadBalancer
).
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.
-
ip-address-type
- The IP address type (ipv4
|ipv6
). -
service-name
- The name of the service. -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
vpc-id
- The ID of the VPC in which the endpoint resides. -
vpc-endpoint-id
- The ID of the endpoint. -
vpc-endpoint-state
- The state of the endpoint (pendingAcceptance
|pending
|available
|deleting
|deleted
|rejected
|failed
). -
vpc-endpoint-type
- The type of VPC endpoint (Interface
|Gateway
|GatewayLoadBalancer
).
-
-
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
- Returns:
- The maximum number of items to return for this request. The request returns a token that you can specify
in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
-
nextToken
public final String nextToken()
The token for the next set of items to return. (You received this token from a prior call.)
- Returns:
- The token for the next set of items to return. (You received this token from a prior call.)
-
toBuilder
public DescribeVpcEndpointsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeVpcEndpointsRequest.Builder,DescribeVpcEndpointsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeVpcEndpointsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeVpcEndpointsRequest.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
-
-