Class UpdateProxyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest
software.amazon.awssdk.services.networkfirewall.model.UpdateProxyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateProxyRequest.Builder,UpdateProxyRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateProxyRequest extends NetworkFirewallRequest implements ToCopyableBuilder<UpdateProxyRequest.Builder,UpdateProxyRequest>

  • Method Details

    • natGatewayId

      public final String natGatewayId()

      The NAT Gateway the proxy is attached to.

      Returns:
      The NAT Gateway the proxy is attached to.

    • proxyName

      public final String proxyName()

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

      You must specify the ARN or the name, and you can specify both.

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

      You must specify the ARN or the name, and you can specify both.

    • proxyArn

      public final String proxyArn()

      The Amazon Resource Name (ARN) of a proxy.

      You must specify the ARN or the name, and you can specify both.

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

      You must specify the ARN or the name, and you can specify both.

    • hasListenerPropertiesToAdd

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

    • listenerPropertiesToAdd

      public final List<ListenerPropertyRequest> listenerPropertiesToAdd()

      Listener properties for HTTP and HTTPS traffic to add.

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

      Returns:
      Listener properties for HTTP and HTTPS traffic to add.

    • hasListenerPropertiesToRemove

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

    • listenerPropertiesToRemove

      public final List<ListenerPropertyRequest> listenerPropertiesToRemove()

      Listener properties for HTTP and HTTPS traffic to remove.

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

      Returns:
      Listener properties for HTTP and HTTPS traffic to remove.

    • tlsInterceptProperties

      public final TlsInterceptPropertiesRequest 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.

    • updateToken

      public final String updateToken()

      A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

      To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

      Returns:
      A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

      To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

    • toBuilder

      public UpdateProxyRequest.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<UpdateProxyRequest.Builder,UpdateProxyRequest>
      Specified by:
      toBuilder in class NetworkFirewallRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateProxyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateProxyRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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