Class DescribeProxyResource

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.DescribeProxyResource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DescribeProxyResource.Builder,DescribeProxyResource>
@Generated("software.amazon.awssdk:codegen") public final class DescribeProxyResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribeProxyResource.Builder,DescribeProxyResource>

Proxy attached to a NAT gateway.

See Also:

  • Method Details

    • proxyName

      public final String proxyName()

      The descriptive name of the proxy. You can't change the name of a proxy after you create it.

      Returns:
      The descriptive name of the proxy. You can't change the name of a proxy after you create it.

    • proxyArn

      public final String proxyArn()

      The Amazon Resource Name (ARN) of a proxy.

      Returns:
      The Amazon Resource Name (ARN) of a proxy.

    • proxyConfigurationName

      public final String proxyConfigurationName()

      The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

      Returns:
      The descriptive name of the proxy configuration. You can't change the name of a proxy configuration after you create it.

    • proxyConfigurationArn

      public final String proxyConfigurationArn()

      The Amazon Resource Name (ARN) of a proxy configuration.

      Returns:
      The Amazon Resource Name (ARN) of a proxy configuration.

    • natGatewayId

      public final String natGatewayId()

      The NAT Gateway for the proxy.

      Returns:
      The NAT Gateway for the proxy.

    • proxyState

      public final ProxyState proxyState()

      Current attachment/detachment status of the Proxy.

      If the service returns an enum value that is not available in the current SDK version, proxyState will return ProxyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from proxyStateAsString().

      Returns:
      Current attachment/detachment status of the Proxy.
      See Also:

    • proxyStateAsString

      public final String proxyStateAsString()

      Current attachment/detachment status of the Proxy.

      If the service returns an enum value that is not available in the current SDK version, proxyState will return ProxyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from proxyStateAsString().

      Returns:
      Current attachment/detachment status of the Proxy.
      See Also:

    • proxyModifyState

      public final ProxyModifyState proxyModifyState()

      Current modification status of the Proxy.

      If the service returns an enum value that is not available in the current SDK version, proxyModifyState will return ProxyModifyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from proxyModifyStateAsString().

      Returns:
      Current modification status of the Proxy.
      See Also:

    • proxyModifyStateAsString

      public final String proxyModifyStateAsString()

      Current modification status of the Proxy.

      If the service returns an enum value that is not available in the current SDK version, proxyModifyState will return ProxyModifyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from proxyModifyStateAsString().

      Returns:
      Current modification status of the Proxy.
      See Also:

    • hasListenerProperties

      public final boolean hasListenerProperties()
      For responses, this returns true if the service returned a value for the ListenerProperties 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.

    • listenerProperties

      public final List<ListenerProperty> listenerProperties()

      Listener properties for HTTP and HTTPS traffic.

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

      Returns:
      Listener properties for HTTP and HTTPS traffic.

    • tlsInterceptProperties

      public final TlsInterceptProperties tlsInterceptProperties()

      TLS decryption on traffic to filter on attributes in the HTTP header.

      Returns:
      TLS decryption on traffic to filter on attributes in the HTTP header.

    • vpcEndpointServiceName

      public final String vpcEndpointServiceName()

      The service endpoint created in the VPC.

      Returns:
      The service endpoint created in the VPC.

    • privateDNSName

      public final String privateDNSName()

      The private DNS name of the Proxy.

      Returns:
      The private DNS name of the Proxy.

    • createTime

      public final Instant createTime()

      Time the Proxy was created.

      Returns:
      Time the Proxy was created.

    • deleteTime

      public final Instant deleteTime()

      Time the Proxy was deleted.

      Returns:
      Time the Proxy was deleted.

    • updateTime

      public final Instant updateTime()

      Time the Proxy was updated.

      Returns:
      Time the Proxy was updated.

    • failureCode

      public final String failureCode()

      Failure code for cases when the Proxy fails to attach or update.

      Returns:
      Failure code for cases when the Proxy fails to attach or update.

    • failureMessage

      public final String failureMessage()

      Failure message for cases when the Proxy fails to attach or update.

      Returns:
      Failure message for cases when the Proxy fails to attach or update.

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

    • tags

      public final List<Tag> tags()

      The key:value pairs to associate with the resource.

      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 key:value pairs to associate with the resource.

    • toBuilder

      public DescribeProxyResource.Builder 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 interface ToCopyableBuilder<DescribeProxyResource.Builder,DescribeProxyResource>
      Returns:
      a builder for type T

    • builder

      public static DescribeProxyResource.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.