Package software.amazon.awssdk.services.appflow.model

Class OAuth2CustomParameter

    • Method Detail

      • key

        public final String key()

        The key of the custom parameter required for OAuth 2.0 authentication.

        Returns:
        The key of the custom parameter required for OAuth 2.0 authentication.

      • isRequired

        public final Boolean isRequired()

        Indicates whether the custom parameter for OAuth 2.0 authentication is required.

        Returns:
        Indicates whether the custom parameter for OAuth 2.0 authentication is required.

      • label

        public final String label()

        The label of the custom parameter used for OAuth 2.0 authentication.

        Returns:
        The label of the custom parameter used for OAuth 2.0 authentication.

      • description

        public final String description()

        A description about the custom parameter used for OAuth 2.0 authentication.

        Returns:
        A description about the custom parameter used for OAuth 2.0 authentication.

      • isSensitiveField

        public final Boolean isSensitiveField()

        Indicates whether this authentication custom parameter is a sensitive field.

        Returns:
        Indicates whether this authentication custom parameter is a sensitive field.

      • hasConnectorSuppliedValues

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

      • connectorSuppliedValues

        public final List<String> connectorSuppliedValues()

        Contains default values for this authentication parameter that are supplied by the connector.

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

        Returns:
        Contains default values for this authentication parameter that are supplied by the connector.

      • typeAsString

        public final String typeAsString()

        Indicates whether custom parameter is used with TokenUrl or AuthUrl.

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

        Returns:
        Indicates whether custom parameter is used with TokenUrl or AuthUrl.
        See Also:
        OAuth2CustomPropType

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