Package software.amazon.awssdk.services.sagemaker.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IdentityProviderOAuthSetting.Builder

Method Summary

Modifier and Type	Method	Description
static IdentityProviderOAuthSetting.Builder	builder()
DataSourceName	dataSourceName()	The name of the data source that you're connecting to.
String	dataSourceNameAsString()	The name of the data source that you're connecting to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
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.
static Class<? extends IdentityProviderOAuthSetting.Builder>	serializableBuilderClass()
FeatureStatus	status()	Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
String	statusAsString()	Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
IdentityProviderOAuthSetting.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

DataSourceName

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:

DataSourceName

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:

FeatureStatus

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:

FeatureStatus

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

Specified by:

toBuilder in interface ToCopyableBuilder<IdentityProviderOAuthSetting.Builder,IdentityProviderOAuthSetting>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo