Package com.azure.resourcemanager.streamanalytics.models

Class OAuthBasedDataSourceProperties

java.lang.Object

com.azure.resourcemanager.streamanalytics.models.OAuthBasedDataSourceProperties

Direct Known Subclasses:

AzureDataLakeStoreOutputDataSourceProperties, PowerBIOutputDataSourceProperties

public class OAuthBasedDataSourceProperties
extends Object

The properties that are associated with data sources that use OAuth as their authentication model.

Constructor Summary

Constructors

Constructor	Description
OAuthBasedDataSourceProperties()

Method Summary

Modifier and Type	Method	Description
String	refreshToken()	Get the refreshToken property: A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source.
String	tokenUserDisplayName()	Get the tokenUserDisplayName property: The user display name of the user that was used to obtain the refresh token.
String	tokenUserPrincipalName()	Get the tokenUserPrincipalName property: The user principal name (UPN) of the user that was used to obtain the refresh token.
void	validate()	Validates the instance.
OAuthBasedDataSourceProperties	withRefreshToken(String refreshToken)	Set the refreshToken property: A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source.
OAuthBasedDataSourceProperties	withTokenUserDisplayName(String tokenUserDisplayName)	Set the tokenUserDisplayName property: The user display name of the user that was used to obtain the refresh token.
OAuthBasedDataSourceProperties	withTokenUserPrincipalName(String tokenUserPrincipalName)	Set the tokenUserPrincipalName property: The user principal name (UPN) of the user that was used to obtain the refresh token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthBasedDataSourceProperties

public OAuthBasedDataSourceProperties()

Method Detail

refreshToken

public String refreshToken()

Get the refreshToken property: A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.

Returns:

the refreshToken value.

withRefreshToken

public OAuthBasedDataSourceProperties withRefreshToken(String refreshToken)

Set the refreshToken property: A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests.

Parameters:

refreshToken - the refreshToken value to set.

Returns:

the OAuthBasedDataSourceProperties object itself.

tokenUserPrincipalName

public String tokenUserPrincipalName()

Get the tokenUserPrincipalName property: The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

Returns:

the tokenUserPrincipalName value.

withTokenUserPrincipalName

public OAuthBasedDataSourceProperties withTokenUserPrincipalName(String tokenUserPrincipalName)

Set the tokenUserPrincipalName property: The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

Parameters:

tokenUserPrincipalName - the tokenUserPrincipalName value to set.

Returns:

the OAuthBasedDataSourceProperties object itself.

tokenUserDisplayName

public String tokenUserDisplayName()

Get the tokenUserDisplayName property: The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

Returns:

the tokenUserDisplayName value.

withTokenUserDisplayName

public OAuthBasedDataSourceProperties withTokenUserDisplayName(String tokenUserDisplayName)

Set the tokenUserDisplayName property: The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token.

Parameters:

tokenUserDisplayName - the tokenUserDisplayName value to set.

Returns:

the OAuthBasedDataSourceProperties object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.