Class IdentityProviderOAuthSetting

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

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external data source, such as Snowflake.

See Also:

  • Method Details

    • dataSourceName

      public final DataSourceName dataSourceName()

      The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

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

      Returns:
      The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.
      See Also:

    • dataSourceNameAsString

      public final String dataSourceNameAsString()

      The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

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

      Returns:
      The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.
      See Also:

    • status

      public final FeatureStatus status()

      Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

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

      Returns:
      Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
      See Also:

    • statusAsString

      public final String statusAsString()

      Describes whether OAuth for a data source is enabled or disabled in the Canvas application.

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

      Returns:
      Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
      See Also:

    • secretArn

      public final String secretArn()

      The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

      Returns:
      The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your identity provider, such as the client ID and secret, authorization URL, and token URL.

    • toBuilder

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

    • builder

      public static IdentityProviderOAuthSetting.Builder builder()

    • serializableBuilderClass

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