com.amazonaws.services.workspacesweb.model.UpdatePortalRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workspacesweb 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.workspacesweb.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdatePortalRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
*
* Standard web portals are authenticated directly through your identity provider. You need to call
* CreateIdentityProvider to integrate your identity provider with your web portal. User and group
* access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single
* Sign-On). Identity sources (including external identity provider integration), plus user and group access to your
* web portal, can be configured in the IAM Identity Center.
*
*/
private String authenticationType;
/**
*
* The name of the web portal. This is not visible to users who log into the web portal.
*
*/
private String displayName;
/**
*
* The type and resources of the underlying instance.
*
*/
private String instanceType;
/**
*
* The maximum number of concurrent sessions for the portal.
*
*/
private Integer maxConcurrentSessions;
/**
*
* The ARN of the web portal.
*
*/
private String portalArn;
/**
*
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
*
* Standard web portals are authenticated directly through your identity provider. You need to call
* CreateIdentityProvider to integrate your identity provider with your web portal. User and group
* access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single
* Sign-On). Identity sources (including external identity provider integration), plus user and group access to your
* web portal, can be configured in the IAM Identity Center.
*
*
* @param authenticationType
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
* Standard web portals are authenticated directly through your identity provider. You need to
* call CreateIdentityProvider to integrate your identity provider with your web portal. User
* and group access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to
* Single Sign-On). Identity sources (including external identity provider integration), plus user and group
* access to your web portal, can be configured in the IAM Identity Center.
* @see AuthenticationType
*/
public void setAuthenticationType(String authenticationType) {
this.authenticationType = authenticationType;
}
/**
*
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
*
* Standard web portals are authenticated directly through your identity provider. You need to call
* CreateIdentityProvider to integrate your identity provider with your web portal. User and group
* access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single
* Sign-On). Identity sources (including external identity provider integration), plus user and group access to your
* web portal, can be configured in the IAM Identity Center.
*
*
* @return The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
* Standard web portals are authenticated directly through your identity provider. You need to
* call CreateIdentityProvider to integrate your identity provider with your web portal. User
* and group access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to
* Single Sign-On). Identity sources (including external identity provider integration), plus user and group
* access to your web portal, can be configured in the IAM Identity Center.
* @see AuthenticationType
*/
public String getAuthenticationType() {
return this.authenticationType;
}
/**
*
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
*
* Standard web portals are authenticated directly through your identity provider. You need to call
* CreateIdentityProvider to integrate your identity provider with your web portal. User and group
* access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single
* Sign-On). Identity sources (including external identity provider integration), plus user and group access to your
* web portal, can be configured in the IAM Identity Center.
*
*
* @param authenticationType
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
* Standard web portals are authenticated directly through your identity provider. You need to
* call CreateIdentityProvider to integrate your identity provider with your web portal. User
* and group access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to
* Single Sign-On). Identity sources (including external identity provider integration), plus user and group
* access to your web portal, can be configured in the IAM Identity Center.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticationType
*/
public UpdatePortalRequest withAuthenticationType(String authenticationType) {
setAuthenticationType(authenticationType);
return this;
}
/**
*
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
*
* Standard web portals are authenticated directly through your identity provider. You need to call
* CreateIdentityProvider to integrate your identity provider with your web portal. User and group
* access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to Single
* Sign-On). Identity sources (including external identity provider integration), plus user and group access to your
* web portal, can be configured in the IAM Identity Center.
*
*
* @param authenticationType
* The type of authentication integration points used when signing into the web portal. Defaults to
* Standard.
*
* Standard web portals are authenticated directly through your identity provider. You need to
* call CreateIdentityProvider to integrate your identity provider with your web portal. User
* and group access to your web portal is controlled through your identity provider.
*
*
* IAM Identity Center web portals are authenticated through IAM Identity Center (successor to
* Single Sign-On). Identity sources (including external identity provider integration), plus user and group
* access to your web portal, can be configured in the IAM Identity Center.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticationType
*/
public UpdatePortalRequest withAuthenticationType(AuthenticationType authenticationType) {
this.authenticationType = authenticationType.toString();
return this;
}
/**
*
* The name of the web portal. This is not visible to users who log into the web portal.
*
*
* @param displayName
* The name of the web portal. This is not visible to users who log into the web portal.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The name of the web portal. This is not visible to users who log into the web portal.
*
*
* @return The name of the web portal. This is not visible to users who log into the web portal.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The name of the web portal. This is not visible to users who log into the web portal.
*
*
* @param displayName
* The name of the web portal. This is not visible to users who log into the web portal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePortalRequest withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The type and resources of the underlying instance.
*
*
* @param instanceType
* The type and resources of the underlying instance.
* @see InstanceType
*/
public void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
/**
*
* The type and resources of the underlying instance.
*
*
* @return The type and resources of the underlying instance.
* @see InstanceType
*/
public String getInstanceType() {
return this.instanceType;
}
/**
*
* The type and resources of the underlying instance.
*
*
* @param instanceType
* The type and resources of the underlying instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceType
*/
public UpdatePortalRequest withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* The type and resources of the underlying instance.
*
*
* @param instanceType
* The type and resources of the underlying instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceType
*/
public UpdatePortalRequest withInstanceType(InstanceType instanceType) {
this.instanceType = instanceType.toString();
return this;
}
/**
*
* The maximum number of concurrent sessions for the portal.
*
*
* @param maxConcurrentSessions
* The maximum number of concurrent sessions for the portal.
*/
public void setMaxConcurrentSessions(Integer maxConcurrentSessions) {
this.maxConcurrentSessions = maxConcurrentSessions;
}
/**
*
* The maximum number of concurrent sessions for the portal.
*
*
* @return The maximum number of concurrent sessions for the portal.
*/
public Integer getMaxConcurrentSessions() {
return this.maxConcurrentSessions;
}
/**
*
* The maximum number of concurrent sessions for the portal.
*
*
* @param maxConcurrentSessions
* The maximum number of concurrent sessions for the portal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePortalRequest withMaxConcurrentSessions(Integer maxConcurrentSessions) {
setMaxConcurrentSessions(maxConcurrentSessions);
return this;
}
/**
*
* The ARN of the web portal.
*
*
* @param portalArn
* The ARN of the web portal.
*/
public void setPortalArn(String portalArn) {
this.portalArn = portalArn;
}
/**
*
* The ARN of the web portal.
*
*
* @return The ARN of the web portal.
*/
public String getPortalArn() {
return this.portalArn;
}
/**
*
* The ARN of the web portal.
*
*
* @param portalArn
* The ARN of the web portal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePortalRequest withPortalArn(String portalArn) {
setPortalArn(portalArn);
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 (getAuthenticationType() != null)
sb.append("AuthenticationType: ").append(getAuthenticationType()).append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append("***Sensitive Data Redacted***").append(",");
if (getInstanceType() != null)
sb.append("InstanceType: ").append(getInstanceType()).append(",");
if (getMaxConcurrentSessions() != null)
sb.append("MaxConcurrentSessions: ").append(getMaxConcurrentSessions()).append(",");
if (getPortalArn() != null)
sb.append("PortalArn: ").append(getPortalArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdatePortalRequest == false)
return false;
UpdatePortalRequest other = (UpdatePortalRequest) obj;
if (other.getAuthenticationType() == null ^ this.getAuthenticationType() == null)
return false;
if (other.getAuthenticationType() != null && other.getAuthenticationType().equals(this.getAuthenticationType()) == false)
return false;
if (other.getDisplayName() == null ^ this.getDisplayName() == null)
return false;
if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false)
return false;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getMaxConcurrentSessions() == null ^ this.getMaxConcurrentSessions() == null)
return false;
if (other.getMaxConcurrentSessions() != null && other.getMaxConcurrentSessions().equals(this.getMaxConcurrentSessions()) == false)
return false;
if (other.getPortalArn() == null ^ this.getPortalArn() == null)
return false;
if (other.getPortalArn() != null && other.getPortalArn().equals(this.getPortalArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAuthenticationType() == null) ? 0 : getAuthenticationType().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getMaxConcurrentSessions() == null) ? 0 : getMaxConcurrentSessions().hashCode());
hashCode = prime * hashCode + ((getPortalArn() == null) ? 0 : getPortalArn().hashCode());
return hashCode;
}
@Override
public UpdatePortalRequest clone() {
return (UpdatePortalRequest) super.clone();
}
}