Class HttpEndpointRequestConfiguration

    • Method Detail

      • contentEncoding

        public final ContentEncoding contentEncoding()

        Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

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

        Returns:
        Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.
        See Also:
        ContentEncoding
      • contentEncodingAsString

        public final String contentEncodingAsString()

        Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

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

        Returns:
        Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.
        See Also:
        ContentEncoding
      • hasCommonAttributes

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

        public final List<HttpEndpointCommonAttribute> commonAttributes()

        Describes the metadata sent to the HTTP endpoint destination.

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

        Returns:
        Describes the metadata sent to the HTTP endpoint destination.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)