Class CreateOAuthClientApplicationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.CreateOAuthClientApplicationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateOAuthClientApplicationRequest.Builder,CreateOAuthClientApplicationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOAuthClientApplicationRequest extends QuickSightRequest implements ToCopyableBuilder<CreateOAuthClientApplicationRequest.Builder,CreateOAuthClientApplicationRequest>

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID.

      Returns:
      The Amazon Web Services account ID.

    • oAuthClientApplicationId

      public final String oAuthClientApplicationId()

      An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      Returns:
      An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

    • name

      public final String name()

      The display name for the OAuthClientApplication.

      Returns:
      The display name for the OAuthClientApplication.

    • oAuthClientAuthenticationType

      public final OAuthClientAuthenticationType oAuthClientAuthenticationType()

      The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.

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

      Returns:
      The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.
      See Also:

    • oAuthClientAuthenticationTypeAsString

      public final String oAuthClientAuthenticationTypeAsString()

      The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.

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

      Returns:
      The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant flow that is used when the data source connects to the identity provider. Valid values are TOKEN.
      See Also:

    • clientId

      public final String clientId()

      The client ID of the OAuth application that is registered with the identity provider.

      Returns:
      The client ID of the OAuth application that is registered with the identity provider.

    • clientSecret

      public final String clientSecret()

      The client secret of the OAuth application that is registered with the identity provider.

      Returns:
      The client secret of the OAuth application that is registered with the identity provider.

    • oAuthTokenEndpointUrl

      public final String oAuthTokenEndpointUrl()

      The token endpoint URL of the identity provider that is used to obtain access tokens.

      Returns:
      The token endpoint URL of the identity provider that is used to obtain access tokens.

    • oAuthAuthorizationEndpointUrl

      public final String oAuthAuthorizationEndpointUrl()

      The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

      Returns:
      The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

    • oAuthScopes

      public final String oAuthScopes()

      The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

      Returns:
      The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

    • dataSourceType

      public final DataSourceType dataSourceType()

      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

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

      Returns:
      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
      See Also:

    • dataSourceTypeAsString

      public final String dataSourceTypeAsString()

      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

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

      Returns:
      The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
      See Also:

    • identityProviderVpcConnectionProperties

      public final VpcConnectionProperties identityProviderVpcConnectionProperties()
      Returns the value of the IdentityProviderVpcConnectionProperties property for this object.
      Returns:
      The value of the IdentityProviderVpcConnectionProperties property for this object.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

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

      Returns:
      Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.

    • toBuilder

      public CreateOAuthClientApplicationRequest.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<CreateOAuthClientApplicationRequest.Builder,CreateOAuthClientApplicationRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static CreateOAuthClientApplicationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOAuthClientApplicationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.