Class DescribeClientVpnEndpointsRequest
- 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.DescribeClientVpnEndpointsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeClientVpnEndpointsRequest.Builder,DescribeClientVpnEndpointsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeClientVpnEndpointsRequest extends Ec2Request implements ToCopyableBuilder<DescribeClientVpnEndpointsRequest.Builder,DescribeClientVpnEndpointsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeClientVpnEndpointsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeClientVpnEndpointsRequest.Builderbuilder()List<String>clientVpnEndpointIds()The ID of the Client VPN endpoint.BooleandryRun()Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Filter>filters()One or more filters.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasClientVpnEndpointIds()For responses, this returns true if the service returned a value for the ClientVpnEndpointIds property.booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()IntegermaxResults()The maximum number of results to return for the request in a single page.StringnextToken()The token to retrieve the next page of results.List<SdkField<?>>sdkFields()static Class<? extends DescribeClientVpnEndpointsRequest.Builder>serializableBuilderClass()DescribeClientVpnEndpointsRequest.BuildertoBuilder()StringtoString()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
-
hasClientVpnEndpointIds
public final boolean hasClientVpnEndpointIds()
For responses, this returns true if the service returned a value for the ClientVpnEndpointIds 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.
-
clientVpnEndpointIds
public final List<String> clientVpnEndpointIds()
The ID of the Client VPN endpoint.
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
hasClientVpnEndpointIds()method.- Returns:
- The ID of the Client VPN endpoint.
-
maxResults
public final Integer maxResults()
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
- Returns:
- The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
-
nextToken
public final String nextToken()
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
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()
One or more filters. Filter names and values are case-sensitive.
-
endpoint-id- The ID of the Client VPN endpoint. -
transport-protocol- The transport protocol (tcp|udp).
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:
- One or more filters. Filter names and values are case-sensitive.
-
endpoint-id- The ID of the Client VPN endpoint. -
transport-protocol- The transport protocol (tcp|udp).
-
-
-
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.
-
toBuilder
public DescribeClientVpnEndpointsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeClientVpnEndpointsRequest.Builder,DescribeClientVpnEndpointsRequest>- Specified by:
toBuilderin classEc2Request
-
builder
public static DescribeClientVpnEndpointsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeClientVpnEndpointsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
-