com.amazonaws.services.appstream.model.Entitlement Maven / Gradle / Ivy
Show all versions of aws-java-sdk-appstream Show documentation
/*
* Copyright 2018-2023 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.appstream.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies an entitlement. Entitlements control access to specific applications within a stack, based on user
* attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming
* URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view
* application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Entitlement implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the entitlement.
*
*/
private String name;
/**
*
* The name of the stack with which the entitlement is associated.
*
*/
private String stackName;
/**
*
* The description of the entitlement.
*
*/
private String description;
/**
*
* Specifies whether all or selected apps are entitled.
*
*/
private String appVisibility;
/**
*
* The attributes of the entitlement.
*
*/
private java.util.List attributes;
/**
*
* The time when the entitlement was created.
*
*/
private java.util.Date createdTime;
/**
*
* The time when the entitlement was last modified.
*
*/
private java.util.Date lastModifiedTime;
/**
*
* The name of the entitlement.
*
*
* @param name
* The name of the entitlement.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the entitlement.
*
*
* @return The name of the entitlement.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the entitlement.
*
*
* @param name
* The name of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withName(String name) {
setName(name);
return this;
}
/**
*
* The name of the stack with which the entitlement is associated.
*
*
* @param stackName
* The name of the stack with which the entitlement is associated.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name of the stack with which the entitlement is associated.
*
*
* @return The name of the stack with which the entitlement is associated.
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name of the stack with which the entitlement is associated.
*
*
* @param stackName
* The name of the stack with which the entitlement is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* The description of the entitlement.
*
*
* @param description
* The description of the entitlement.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the entitlement.
*
*
* @return The description of the entitlement.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the entitlement.
*
*
* @param description
* The description of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* @param appVisibility
* Specifies whether all or selected apps are entitled.
* @see AppVisibility
*/
public void setAppVisibility(String appVisibility) {
this.appVisibility = appVisibility;
}
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* @return Specifies whether all or selected apps are entitled.
* @see AppVisibility
*/
public String getAppVisibility() {
return this.appVisibility;
}
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* @param appVisibility
* Specifies whether all or selected apps are entitled.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppVisibility
*/
public Entitlement withAppVisibility(String appVisibility) {
setAppVisibility(appVisibility);
return this;
}
/**
*
* Specifies whether all or selected apps are entitled.
*
*
* @param appVisibility
* Specifies whether all or selected apps are entitled.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppVisibility
*/
public Entitlement withAppVisibility(AppVisibility appVisibility) {
this.appVisibility = appVisibility.toString();
return this;
}
/**
*
* The attributes of the entitlement.
*
*
* @return The attributes of the entitlement.
*/
public java.util.List getAttributes() {
return attributes;
}
/**
*
* The attributes of the entitlement.
*
*
* @param attributes
* The attributes of the entitlement.
*/
public void setAttributes(java.util.Collection attributes) {
if (attributes == null) {
this.attributes = null;
return;
}
this.attributes = new java.util.ArrayList(attributes);
}
/**
*
* The attributes of the entitlement.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAttributes(java.util.Collection)} or {@link #withAttributes(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param attributes
* The attributes of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withAttributes(EntitlementAttribute... attributes) {
if (this.attributes == null) {
setAttributes(new java.util.ArrayList(attributes.length));
}
for (EntitlementAttribute ele : attributes) {
this.attributes.add(ele);
}
return this;
}
/**
*
* The attributes of the entitlement.
*
*
* @param attributes
* The attributes of the entitlement.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withAttributes(java.util.Collection attributes) {
setAttributes(attributes);
return this;
}
/**
*
* The time when the entitlement was created.
*
*
* @param createdTime
* The time when the entitlement was created.
*/
public void setCreatedTime(java.util.Date createdTime) {
this.createdTime = createdTime;
}
/**
*
* The time when the entitlement was created.
*
*
* @return The time when the entitlement was created.
*/
public java.util.Date getCreatedTime() {
return this.createdTime;
}
/**
*
* The time when the entitlement was created.
*
*
* @param createdTime
* The time when the entitlement was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withCreatedTime(java.util.Date createdTime) {
setCreatedTime(createdTime);
return this;
}
/**
*
* The time when the entitlement was last modified.
*
*
* @param lastModifiedTime
* The time when the entitlement was last modified.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* The time when the entitlement was last modified.
*
*
* @return The time when the entitlement was last modified.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* The time when the entitlement was last modified.
*
*
* @param lastModifiedTime
* The time when the entitlement was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Entitlement withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getAppVisibility() != null)
sb.append("AppVisibility: ").append(getAppVisibility()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getCreatedTime() != null)
sb.append("CreatedTime: ").append(getCreatedTime()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Entitlement == false)
return false;
Entitlement other = (Entitlement) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getAppVisibility() == null ^ this.getAppVisibility() == null)
return false;
if (other.getAppVisibility() != null && other.getAppVisibility().equals(this.getAppVisibility()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getCreatedTime() == null ^ this.getCreatedTime() == null)
return false;
if (other.getCreatedTime() != null && other.getCreatedTime().equals(this.getCreatedTime()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getAppVisibility() == null) ? 0 : getAppVisibility().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getCreatedTime() == null) ? 0 : getCreatedTime().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
return hashCode;
}
@Override
public Entitlement clone() {
try {
return (Entitlement) 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.appstream.model.transform.EntitlementMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}