com.amazonaws.services.amplifybackend.model.UpdateBackendAuthOAuthConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-amplifybackend Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.amplifybackend.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The OAuth configurations for authenticating users into your Amplify app.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateBackendAuthOAuthConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Cognito domain prefix used to create a hosted UI for authentication.
*
*/
private String domainPrefix;
/**
*
* The OAuth grant type to allow app users to authenticate from your Amplify app.
*
*/
private String oAuthGrantType;
/**
*
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
*
*/
private java.util.List oAuthScopes;
/**
*
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*
*/
private java.util.List redirectSignInURIs;
/**
*
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*
*/
private java.util.List redirectSignOutURIs;
/**
*
* Describes third-party social federation configurations for allowing your users to sign in with OAuth.
*
*/
private SocialProviderSettings socialProviderSettings;
/**
*
* The Amazon Cognito domain prefix used to create a hosted UI for authentication.
*
*
* @param domainPrefix
* The Amazon Cognito domain prefix used to create a hosted UI for authentication.
*/
public void setDomainPrefix(String domainPrefix) {
this.domainPrefix = domainPrefix;
}
/**
*
* The Amazon Cognito domain prefix used to create a hosted UI for authentication.
*
*
* @return The Amazon Cognito domain prefix used to create a hosted UI for authentication.
*/
public String getDomainPrefix() {
return this.domainPrefix;
}
/**
*
* The Amazon Cognito domain prefix used to create a hosted UI for authentication.
*
*
* @param domainPrefix
* The Amazon Cognito domain prefix used to create a hosted UI for authentication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateBackendAuthOAuthConfig withDomainPrefix(String domainPrefix) {
setDomainPrefix(domainPrefix);
return this;
}
/**
*
* The OAuth grant type to allow app users to authenticate from your Amplify app.
*
*
* @param oAuthGrantType
* The OAuth grant type to allow app users to authenticate from your Amplify app.
* @see OAuthGrantType
*/
public void setOAuthGrantType(String oAuthGrantType) {
this.oAuthGrantType = oAuthGrantType;
}
/**
*
* The OAuth grant type to allow app users to authenticate from your Amplify app.
*
*
* @return The OAuth grant type to allow app users to authenticate from your Amplify app.
* @see OAuthGrantType
*/
public String getOAuthGrantType() {
return this.oAuthGrantType;
}
/**
*
* The OAuth grant type to allow app users to authenticate from your Amplify app.
*
*
* @param oAuthGrantType
* The OAuth grant type to allow app users to authenticate from your Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OAuthGrantType
*/
public UpdateBackendAuthOAuthConfig withOAuthGrantType(String oAuthGrantType) {
setOAuthGrantType(oAuthGrantType);
return this;
}
/**
*
* The OAuth grant type to allow app users to authenticate from your Amplify app.
*
*
* @param oAuthGrantType
* The OAuth grant type to allow app users to authenticate from your Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OAuthGrantType
*/
public UpdateBackendAuthOAuthConfig withOAuthGrantType(OAuthGrantType oAuthGrantType) {
this.oAuthGrantType = oAuthGrantType.toString();
return this;
}
/**
*
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
*
*
* @return The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
* @see OAuthScopesElement
*/
public java.util.List getOAuthScopes() {
return oAuthScopes;
}
/**
*
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
*
*
* @param oAuthScopes
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
* @see OAuthScopesElement
*/
public void setOAuthScopes(java.util.Collection oAuthScopes) {
if (oAuthScopes == null) {
this.oAuthScopes = null;
return;
}
this.oAuthScopes = new java.util.ArrayList(oAuthScopes);
}
/**
*
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOAuthScopes(java.util.Collection)} or {@link #withOAuthScopes(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param oAuthScopes
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OAuthScopesElement
*/
public UpdateBackendAuthOAuthConfig withOAuthScopes(String... oAuthScopes) {
if (this.oAuthScopes == null) {
setOAuthScopes(new java.util.ArrayList(oAuthScopes.length));
}
for (String ele : oAuthScopes) {
this.oAuthScopes.add(ele);
}
return this;
}
/**
*
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
*
*
* @param oAuthScopes
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OAuthScopesElement
*/
public UpdateBackendAuthOAuthConfig withOAuthScopes(java.util.Collection oAuthScopes) {
setOAuthScopes(oAuthScopes);
return this;
}
/**
*
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
*
*
* @param oAuthScopes
* The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OAuthScopesElement
*/
public UpdateBackendAuthOAuthConfig withOAuthScopes(OAuthScopesElement... oAuthScopes) {
java.util.ArrayList oAuthScopesCopy = new java.util.ArrayList(oAuthScopes.length);
for (OAuthScopesElement value : oAuthScopes) {
oAuthScopesCopy.add(value.toString());
}
if (getOAuthScopes() == null) {
setOAuthScopes(oAuthScopesCopy);
} else {
getOAuthScopes().addAll(oAuthScopesCopy);
}
return this;
}
/**
*
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*
*
* @return Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*/
public java.util.List getRedirectSignInURIs() {
return redirectSignInURIs;
}
/**
*
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*
*
* @param redirectSignInURIs
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*/
public void setRedirectSignInURIs(java.util.Collection redirectSignInURIs) {
if (redirectSignInURIs == null) {
this.redirectSignInURIs = null;
return;
}
this.redirectSignInURIs = new java.util.ArrayList(redirectSignInURIs);
}
/**
*
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRedirectSignInURIs(java.util.Collection)} or {@link #withRedirectSignInURIs(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param redirectSignInURIs
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateBackendAuthOAuthConfig withRedirectSignInURIs(String... redirectSignInURIs) {
if (this.redirectSignInURIs == null) {
setRedirectSignInURIs(new java.util.ArrayList(redirectSignInURIs.length));
}
for (String ele : redirectSignInURIs) {
this.redirectSignInURIs.add(ele);
}
return this;
}
/**
*
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*
*
* @param redirectSignInURIs
* Redirect URLs that OAuth uses when a user signs in to an Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateBackendAuthOAuthConfig withRedirectSignInURIs(java.util.Collection redirectSignInURIs) {
setRedirectSignInURIs(redirectSignInURIs);
return this;
}
/**
*
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*
*
* @return Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*/
public java.util.List getRedirectSignOutURIs() {
return redirectSignOutURIs;
}
/**
*
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*
*
* @param redirectSignOutURIs
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*/
public void setRedirectSignOutURIs(java.util.Collection redirectSignOutURIs) {
if (redirectSignOutURIs == null) {
this.redirectSignOutURIs = null;
return;
}
this.redirectSignOutURIs = new java.util.ArrayList(redirectSignOutURIs);
}
/**
*
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRedirectSignOutURIs(java.util.Collection)} or {@link #withRedirectSignOutURIs(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param redirectSignOutURIs
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateBackendAuthOAuthConfig withRedirectSignOutURIs(String... redirectSignOutURIs) {
if (this.redirectSignOutURIs == null) {
setRedirectSignOutURIs(new java.util.ArrayList(redirectSignOutURIs.length));
}
for (String ele : redirectSignOutURIs) {
this.redirectSignOutURIs.add(ele);
}
return this;
}
/**
*
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*
*
* @param redirectSignOutURIs
* Redirect URLs that OAuth uses when a user signs out of an Amplify app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateBackendAuthOAuthConfig withRedirectSignOutURIs(java.util.Collection redirectSignOutURIs) {
setRedirectSignOutURIs(redirectSignOutURIs);
return this;
}
/**
*
* Describes third-party social federation configurations for allowing your users to sign in with OAuth.
*
*
* @param socialProviderSettings
* Describes third-party social federation configurations for allowing your users to sign in with OAuth.
*/
public void setSocialProviderSettings(SocialProviderSettings socialProviderSettings) {
this.socialProviderSettings = socialProviderSettings;
}
/**
*
* Describes third-party social federation configurations for allowing your users to sign in with OAuth.
*
*
* @return Describes third-party social federation configurations for allowing your users to sign in with OAuth.
*/
public SocialProviderSettings getSocialProviderSettings() {
return this.socialProviderSettings;
}
/**
*
* Describes third-party social federation configurations for allowing your users to sign in with OAuth.
*
*
* @param socialProviderSettings
* Describes third-party social federation configurations for allowing your users to sign in with OAuth.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateBackendAuthOAuthConfig withSocialProviderSettings(SocialProviderSettings socialProviderSettings) {
setSocialProviderSettings(socialProviderSettings);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDomainPrefix() != null)
sb.append("DomainPrefix: ").append(getDomainPrefix()).append(",");
if (getOAuthGrantType() != null)
sb.append("OAuthGrantType: ").append(getOAuthGrantType()).append(",");
if (getOAuthScopes() != null)
sb.append("OAuthScopes: ").append(getOAuthScopes()).append(",");
if (getRedirectSignInURIs() != null)
sb.append("RedirectSignInURIs: ").append(getRedirectSignInURIs()).append(",");
if (getRedirectSignOutURIs() != null)
sb.append("RedirectSignOutURIs: ").append(getRedirectSignOutURIs()).append(",");
if (getSocialProviderSettings() != null)
sb.append("SocialProviderSettings: ").append(getSocialProviderSettings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateBackendAuthOAuthConfig == false)
return false;
UpdateBackendAuthOAuthConfig other = (UpdateBackendAuthOAuthConfig) obj;
if (other.getDomainPrefix() == null ^ this.getDomainPrefix() == null)
return false;
if (other.getDomainPrefix() != null && other.getDomainPrefix().equals(this.getDomainPrefix()) == false)
return false;
if (other.getOAuthGrantType() == null ^ this.getOAuthGrantType() == null)
return false;
if (other.getOAuthGrantType() != null && other.getOAuthGrantType().equals(this.getOAuthGrantType()) == false)
return false;
if (other.getOAuthScopes() == null ^ this.getOAuthScopes() == null)
return false;
if (other.getOAuthScopes() != null && other.getOAuthScopes().equals(this.getOAuthScopes()) == false)
return false;
if (other.getRedirectSignInURIs() == null ^ this.getRedirectSignInURIs() == null)
return false;
if (other.getRedirectSignInURIs() != null && other.getRedirectSignInURIs().equals(this.getRedirectSignInURIs()) == false)
return false;
if (other.getRedirectSignOutURIs() == null ^ this.getRedirectSignOutURIs() == null)
return false;
if (other.getRedirectSignOutURIs() != null && other.getRedirectSignOutURIs().equals(this.getRedirectSignOutURIs()) == false)
return false;
if (other.getSocialProviderSettings() == null ^ this.getSocialProviderSettings() == null)
return false;
if (other.getSocialProviderSettings() != null && other.getSocialProviderSettings().equals(this.getSocialProviderSettings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomainPrefix() == null) ? 0 : getDomainPrefix().hashCode());
hashCode = prime * hashCode + ((getOAuthGrantType() == null) ? 0 : getOAuthGrantType().hashCode());
hashCode = prime * hashCode + ((getOAuthScopes() == null) ? 0 : getOAuthScopes().hashCode());
hashCode = prime * hashCode + ((getRedirectSignInURIs() == null) ? 0 : getRedirectSignInURIs().hashCode());
hashCode = prime * hashCode + ((getRedirectSignOutURIs() == null) ? 0 : getRedirectSignOutURIs().hashCode());
hashCode = prime * hashCode + ((getSocialProviderSettings() == null) ? 0 : getSocialProviderSettings().hashCode());
return hashCode;
}
@Override
public UpdateBackendAuthOAuthConfig clone() {
try {
return (UpdateBackendAuthOAuthConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.amplifybackend.model.transform.UpdateBackendAuthOAuthConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}