Class VpcEndpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VpcEndpoint.Builder,
VpcEndpoint>
Describes a VPC endpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic VpcEndpoint.Builder
builder()
final Instant
The date and time that the endpoint was created.(Interface endpoint) The DNS entries for the endpoint.final DnsOptions
The DNS options for the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final List
<SecurityGroupIdentifier> groups()
(Interface endpoint) Information about the security groups that are associated with the network interface.final boolean
For responses, this returns true if the service returned a value for the DnsEntries property.final boolean
For responses, this returns true if the service returned a value for the Groups property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.final boolean
For responses, this returns true if the service returned a value for the RouteTableIds property.final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final IpAddressType
The IP address type for the endpoint.final String
The IP address type for the endpoint.final LastError
The last error that occurred for endpoint.(Interface endpoint) The network interfaces for the endpoint.final String
ownerId()
The ID of the Amazon Web Services account that owns the endpoint.final String
The policy document associated with the endpoint, if applicable.final Boolean
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.final Boolean
Indicates whether the endpoint is being managed by its service.(Gateway endpoint) The IDs of the route tables associated with the endpoint.static Class
<? extends VpcEndpoint.Builder> final String
The name of the service to which the endpoint is associated.final State
state()
The state of the endpoint.final String
The state of the endpoint.(Interface endpoint) The subnets for the endpoint.tags()
The tags assigned to the endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the endpoint.final VpcEndpointType
The type of endpoint.final String
The type of endpoint.final String
vpcId()
The ID of the VPC to which the endpoint is associated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
vpcEndpointId
The ID of the endpoint.
- Returns:
- The ID of the endpoint.
-
vpcEndpointType
The type of endpoint.
If the service returns an enum value that is not available in the current SDK version,
vpcEndpointType
will returnVpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvpcEndpointTypeAsString()
.- Returns:
- The type of endpoint.
- See Also:
-
vpcEndpointTypeAsString
The type of endpoint.
If the service returns an enum value that is not available in the current SDK version,
vpcEndpointType
will returnVpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvpcEndpointTypeAsString()
.- Returns:
- The type of endpoint.
- See Also:
-
vpcId
The ID of the VPC to which the endpoint is associated.
- Returns:
- The ID of the VPC to which the endpoint is associated.
-
serviceName
The name of the service to which the endpoint is associated.
- Returns:
- The name of the service to which the endpoint is associated.
-
state
The state of the endpoint.
If the service returns an enum value that is not available in the current SDK version,
state
will returnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the endpoint.
- See Also:
-
stateAsString
The state of the endpoint.
If the service returns an enum value that is not available in the current SDK version,
state
will returnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the endpoint.
- See Also:
-
policyDocument
The policy document associated with the endpoint, if applicable.
- Returns:
- The policy document associated with the endpoint, if applicable.
-
hasRouteTableIds
public final boolean hasRouteTableIds()For responses, this returns true if the service returned a value for the RouteTableIds 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. -
routeTableIds
(Gateway endpoint) The IDs of the route tables associated with the 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
hasRouteTableIds()
method.- Returns:
- (Gateway endpoint) The IDs of the route tables associated with the endpoint.
-
hasSubnetIds
public final boolean hasSubnetIds()For responses, this returns true if the service returned a value for the SubnetIds 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. -
subnetIds
(Interface endpoint) The subnets for the 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
hasSubnetIds()
method.- Returns:
- (Interface endpoint) The subnets for the endpoint.
-
hasGroups
public final boolean hasGroups()For responses, this returns true if the service returned a value for the Groups 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. -
groups
(Interface endpoint) Information about the security groups that are associated with the network interface.
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
hasGroups()
method.- Returns:
- (Interface endpoint) Information about the security groups that are associated with the network interface.
-
ipAddressType
The IP address type for the endpoint.
If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the endpoint.
- See Also:
-
ipAddressTypeAsString
The IP address type for the endpoint.
If the service returns an enum value that is not available in the current SDK version,
ipAddressType
will returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the endpoint.
- See Also:
-
dnsOptions
The DNS options for the endpoint.
- Returns:
- The DNS options for the endpoint.
-
privateDnsEnabled
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
- Returns:
- (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
-
requesterManaged
Indicates whether the endpoint is being managed by its service.
- Returns:
- Indicates whether the endpoint is being managed by its service.
-
hasNetworkInterfaceIds
public final boolean hasNetworkInterfaceIds()For responses, this returns true if the service returned a value for the NetworkInterfaceIds 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. -
networkInterfaceIds
(Interface endpoint) The network interfaces for the 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
hasNetworkInterfaceIds()
method.- Returns:
- (Interface endpoint) The network interfaces for the endpoint.
-
hasDnsEntries
public final boolean hasDnsEntries()For responses, this returns true if the service returned a value for the DnsEntries 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. -
dnsEntries
(Interface endpoint) The DNS entries for the 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
hasDnsEntries()
method.- Returns:
- (Interface endpoint) The DNS entries for the endpoint.
-
creationTimestamp
The date and time that the endpoint was created.
- Returns:
- The date and time that the endpoint was created.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
The tags assigned to the 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
hasTags()
method.- Returns:
- The tags assigned to the endpoint.
-
ownerId
The ID of the Amazon Web Services account that owns the endpoint.
- Returns:
- The ID of the Amazon Web Services account that owns the endpoint.
-
lastError
The last error that occurred for endpoint.
- Returns:
- The last error that occurred for endpoint.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VpcEndpoint.Builder,
VpcEndpoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-