Class ExternalProxy

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

Configuration for a customer-managed external proxy server. Includes server location, optional domain-based routing patterns, and authentication credentials.

See Also:

  • Method Details

    • server

      public final String server()

      The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).

      Returns:
      The hostname of the proxy server. Must be a valid DNS hostname (maximum 253 characters).

    • port

      public final Integer port()

      The port number of the proxy server. Valid range: 1-65535.

      Returns:
      The port number of the proxy server. Valid range: 1-65535.

    • hasDomainPatterns

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

    • domainPatterns

      public final List<String> domainPatterns()

      Optional array of domain patterns that should route through this specific proxy. Supports .example.com for subdomain matching (matches any subdomain of example.com) or example.com for exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.

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

      Returns:
      Optional array of domain patterns that should route through this specific proxy. Supports .example.com for subdomain matching (matches any subdomain of example.com) or example.com for exact domain matching. If omitted, this proxy acts as a catch-all for domains not matched by other proxies. Maximum 100 patterns per proxy, each up to 253 characters.

    • credentials

      public final ProxyCredentials credentials()

      Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).

      Returns:
      Optional authentication credentials for the proxy server. If omitted, the proxy is accessed without authentication (useful for IP-allowlisted proxies).

    • toBuilder

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

    • builder

      public static ExternalProxy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExternalProxy.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.