Package software.amazon.awssdk.services.ec2.model

Class DescribeVpcPeeringConnectionsRequest

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.DescribeVpcPeeringConnectionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeVpcPeeringConnectionsRequest.Builder,DescribeVpcPeeringConnectionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeVpcPeeringConnectionsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeVpcPeeringConnectionsRequest.Builder,DescribeVpcPeeringConnectionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeVpcPeeringConnectionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeVpcPeeringConnectionsRequest.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	hasVpcPeeringConnectionIds()	For responses, this returns true if the service returned a value for the VpcPeeringConnectionIds property.
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 DescribeVpcPeeringConnectionsRequest.Builder>	serializableBuilderClass()
DescribeVpcPeeringConnectionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	vpcPeeringConnectionIds()	The IDs of the VPC peering connections.

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 the isEmpty() 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.

• accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

• accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.

• accepter-vpc-info.vpc-id - The ID of the accepter VPC.

• expiration-time - The expiration date and time for the VPC peering connection.

• requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.

• requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.

• requester-vpc-info.vpc-id - The ID of the requester VPC.

• status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

• status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

• 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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-peering-connection-id - The ID of the VPC peering connection.

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.

• accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

• accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.

• accepter-vpc-info.vpc-id - The ID of the accepter VPC.

• expiration-time - The expiration date and time for the VPC peering connection.

• requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.

• requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.

• requester-vpc-info.vpc-id - The ID of the requester VPC.

• status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

• status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

• 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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-peering-connection-id - The ID of the VPC peering connection.

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 is UnauthorizedOperation.

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 is UnauthorizedOperation.

hasVpcPeeringConnectionIds

public final boolean hasVpcPeeringConnectionIds()

For responses, this returns true if the service returned a value for the VpcPeeringConnectionIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

vpcPeeringConnectionIds

public final List<String> vpcPeeringConnectionIds()

The IDs of the VPC peering connections.

Default: Describes all your VPC peering connections.

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 hasVpcPeeringConnectionIds() method.

Returns:

The IDs of the VPC peering connections.

Default: Describes all your VPC peering connections.

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.

maxResults

public final Integer maxResults()

The maximum number of items to return for this request. 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. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

toBuilder

public DescribeVpcPeeringConnectionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeVpcPeeringConnectionsRequest.Builder,DescribeVpcPeeringConnectionsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeVpcPeeringConnectionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeVpcPeeringConnectionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo