All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.vmware.avi.sdk.model.AuthMappingRule Maven / Gradle / Ivy

Go to download

Avi SDK is a java API which creates a session with controller and perform CRUD operations.

There is a newer version: 31.1.1.RELEASE
Show newest version
/*
 * Copyright 2021 VMware, Inc.
 * SPDX-License-Identifier: Apache License 2.0
 */

package com.vmware.avi.sdk.model;

import java.util.*;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * The AuthMappingRule is a POJO class extends AviRestResource that used for creating
 * AuthMappingRule.
 *
 * @version 1.0
 * @since 
 *
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class AuthMappingRule  {
    @JsonProperty("assign_policy")
    private String assignPolicy;

    @JsonProperty("assign_role")
    private String assignRole;

    @JsonProperty("assign_tenant")
    private String assignTenant;

    @JsonProperty("assign_userprofile")
    private String assignUserprofile;

    @JsonProperty("attribute_match")
    private AuthMatchAttribute attributeMatch;

    @JsonProperty("default_tenant_ref")
    private String defaultTenantRef;

    @JsonProperty("group_match")
    private AuthMatchGroupMembership groupMatch;

    @JsonProperty("index")
    private Integer index;

    @JsonProperty("is_superuser")
    private Boolean isSuperuser;

    @JsonProperty("policy_attribute_name")
    private String policyAttributeName;

    @JsonProperty("role_attribute_name")
    private String roleAttributeName;

    @JsonProperty("role_refs")
    private List roleRefs;

    @JsonProperty("tenant_attribute_name")
    private String tenantAttributeName;

    @JsonProperty("tenant_refs")
    private List tenantRefs;

    @JsonProperty("userprofile_attribute_name")
    private String userprofileAttributeName;

    @JsonProperty("userprofile_ref")
    private String userprofileRef;



    /**
     * This is the getter method this will return the attribute value.
     * Assignment rule for the object access policy.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Field introduced in 18.2.7, 20.1.1.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return assignPolicy
     */
    public String getAssignPolicy() {
        return assignPolicy;
    }

    /**
     * This is the setter method to the attribute.
     * Assignment rule for the object access policy.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Field introduced in 18.2.7, 20.1.1.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param assignPolicy set the assignPolicy.
     */
    public void setAssignPolicy(String  assignPolicy) {
        this.assignPolicy = assignPolicy;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return assignRole
     */
    public String getAssignRole() {
        return assignRole;
    }

    /**
     * This is the setter method to the attribute.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param assignRole set the assignRole.
     */
    public void setAssignRole(String  assignRole) {
        this.assignRole = assignRole;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return assignTenant
     */
    public String getAssignTenant() {
        return assignTenant;
    }

    /**
     * This is the setter method to the attribute.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param assignTenant set the assignTenant.
     */
    public void setAssignTenant(String  assignTenant) {
        this.assignTenant = assignTenant;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Assignment rule for the user account profile.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Field introduced in 20.1.3.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return assignUserprofile
     */
    public String getAssignUserprofile() {
        return assignUserprofile;
    }

    /**
     * This is the setter method to the attribute.
     * Assignment rule for the user account profile.
     * Enum options - ASSIGN_ALL, ASSIGN_FROM_SELECT_LIST, ASSIGN_MATCHING_GROUP_NAME, ASSIGN_MATCHING_ATTRIBUTE_VALUE, ASSIGN_MATCHING_GROUP_REGEX,
     * ASSIGN_MATCHING_ATTRIBUTE_REGEX, ASSIGN_CONFIG_CONTAINS_ATTRIBUTE_VALUE.
     * Field introduced in 20.1.3.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param assignUserprofile set the assignUserprofile.
     */
    public void setAssignUserprofile(String  assignUserprofile) {
        this.assignUserprofile = assignUserprofile;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return attributeMatch
     */
    public AuthMatchAttribute getAttributeMatch() {
        return attributeMatch;
    }

    /**
     * This is the setter method to the attribute.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param attributeMatch set the attributeMatch.
     */
    public void setAttributeMatch(AuthMatchAttribute attributeMatch) {
        this.attributeMatch = attributeMatch;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Default tenant ref to assign to user.
     * It is a reference to an object of type tenant.
     * Field introduced in 22.1.1.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return defaultTenantRef
     */
    public String getDefaultTenantRef() {
        return defaultTenantRef;
    }

    /**
     * This is the setter method to the attribute.
     * Default tenant ref to assign to user.
     * It is a reference to an object of type tenant.
     * Field introduced in 22.1.1.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param defaultTenantRef set the defaultTenantRef.
     */
    public void setDefaultTenantRef(String  defaultTenantRef) {
        this.defaultTenantRef = defaultTenantRef;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return groupMatch
     */
    public AuthMatchGroupMembership getGroupMatch() {
        return groupMatch;
    }

    /**
     * This is the setter method to the attribute.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param groupMatch set the groupMatch.
     */
    public void setGroupMatch(AuthMatchGroupMembership groupMatch) {
        this.groupMatch = groupMatch;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return index
     */
    public Integer getIndex() {
        return index;
    }

    /**
     * This is the setter method to the attribute.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param index set the index.
     */
    public void setIndex(Integer  index) {
        this.index = index;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return isSuperuser
     */
    public Boolean getIsSuperuser() {
        return isSuperuser;
    }

    /**
     * This is the setter method to the attribute.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param isSuperuser set the isSuperuser.
     */
    public void setIsSuperuser(Boolean  isSuperuser) {
        this.isSuperuser = isSuperuser;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Attribute name for object access policy assignment.
     * Field introduced in 18.2.7, 20.1.1.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return policyAttributeName
     */
    public String getPolicyAttributeName() {
        return policyAttributeName;
    }

    /**
     * This is the setter method to the attribute.
     * Attribute name for object access policy assignment.
     * Field introduced in 18.2.7, 20.1.1.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param policyAttributeName set the policyAttributeName.
     */
    public void setPolicyAttributeName(String  policyAttributeName) {
        this.policyAttributeName = policyAttributeName;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return roleAttributeName
     */
    public String getRoleAttributeName() {
        return roleAttributeName;
    }

    /**
     * This is the setter method to the attribute.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param roleAttributeName set the roleAttributeName.
     */
    public void setRoleAttributeName(String  roleAttributeName) {
        this.roleAttributeName = roleAttributeName;
    }
    /**
     * This is the getter method this will return the attribute value.
     * It is a reference to an object of type role.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return roleRefs
     */
    public List getRoleRefs() {
        return roleRefs;
    }

    /**
     * This is the setter method. this will set the roleRefs
     * It is a reference to an object of type role.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return roleRefs
     */
    public void setRoleRefs(List  roleRefs) {
        this.roleRefs = roleRefs;
    }

    /**
     * This is the setter method this will set the roleRefs
     * It is a reference to an object of type role.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return roleRefs
     */
    public AuthMappingRule addRoleRefsItem(String roleRefsItem) {
      if (this.roleRefs == null) {
        this.roleRefs = new ArrayList();
      }
      this.roleRefs.add(roleRefsItem);
      return this;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return tenantAttributeName
     */
    public String getTenantAttributeName() {
        return tenantAttributeName;
    }

    /**
     * This is the setter method to the attribute.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param tenantAttributeName set the tenantAttributeName.
     */
    public void setTenantAttributeName(String  tenantAttributeName) {
        this.tenantAttributeName = tenantAttributeName;
    }
    /**
     * This is the getter method this will return the attribute value.
     * It is a reference to an object of type tenant.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return tenantRefs
     */
    public List getTenantRefs() {
        return tenantRefs;
    }

    /**
     * This is the setter method. this will set the tenantRefs
     * It is a reference to an object of type tenant.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return tenantRefs
     */
    public void setTenantRefs(List  tenantRefs) {
        this.tenantRefs = tenantRefs;
    }

    /**
     * This is the setter method this will set the tenantRefs
     * It is a reference to an object of type tenant.
     * Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return tenantRefs
     */
    public AuthMappingRule addTenantRefsItem(String tenantRefsItem) {
      if (this.tenantRefs == null) {
        this.tenantRefs = new ArrayList();
      }
      this.tenantRefs.add(tenantRefsItem);
      return this;
    }

    /**
     * This is the getter method this will return the attribute value.
     * Attribute name for user account profile assignment.
     * Field introduced in 20.1.3.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return userprofileAttributeName
     */
    public String getUserprofileAttributeName() {
        return userprofileAttributeName;
    }

    /**
     * This is the setter method to the attribute.
     * Attribute name for user account profile assignment.
     * Field introduced in 20.1.3.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param userprofileAttributeName set the userprofileAttributeName.
     */
    public void setUserprofileAttributeName(String  userprofileAttributeName) {
        this.userprofileAttributeName = userprofileAttributeName;
    }

    /**
     * This is the getter method this will return the attribute value.
     * User account profile to assign to user on successful match.
     * It is a reference to an object of type useraccountprofile.
     * Field introduced in 20.1.3.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @return userprofileRef
     */
    public String getUserprofileRef() {
        return userprofileRef;
    }

    /**
     * This is the setter method to the attribute.
     * User account profile to assign to user on successful match.
     * It is a reference to an object of type useraccountprofile.
     * Field introduced in 20.1.3.
     * Allowed in enterprise edition with any value, enterprise with cloud services edition.
     * Default value when not specified in API or module is interpreted by Avi Controller as null.
     * @param userprofileRef set the userprofileRef.
     */
    public void setUserprofileRef(String  userprofileRef) {
        this.userprofileRef = userprofileRef;
    }


    @Override
    public boolean equals(java.lang.Object o) {
      if (this == o) {
          return true;
      }
      if (o == null || getClass() != o.getClass()) {
          return false;
      }
      AuthMappingRule objAuthMappingRule = (AuthMappingRule) o;
      return   Objects.equals(this.index, objAuthMappingRule.index)&&
  Objects.equals(this.groupMatch, objAuthMappingRule.groupMatch)&&
  Objects.equals(this.attributeMatch, objAuthMappingRule.attributeMatch)&&
  Objects.equals(this.assignTenant, objAuthMappingRule.assignTenant)&&
  Objects.equals(this.tenantAttributeName, objAuthMappingRule.tenantAttributeName)&&
  Objects.equals(this.tenantRefs, objAuthMappingRule.tenantRefs)&&
  Objects.equals(this.assignRole, objAuthMappingRule.assignRole)&&
  Objects.equals(this.roleAttributeName, objAuthMappingRule.roleAttributeName)&&
  Objects.equals(this.roleRefs, objAuthMappingRule.roleRefs)&&
  Objects.equals(this.isSuperuser, objAuthMappingRule.isSuperuser)&&
  Objects.equals(this.assignPolicy, objAuthMappingRule.assignPolicy)&&
  Objects.equals(this.policyAttributeName, objAuthMappingRule.policyAttributeName)&&
  Objects.equals(this.assignUserprofile, objAuthMappingRule.assignUserprofile)&&
  Objects.equals(this.userprofileAttributeName, objAuthMappingRule.userprofileAttributeName)&&
  Objects.equals(this.userprofileRef, objAuthMappingRule.userprofileRef)&&
  Objects.equals(this.defaultTenantRef, objAuthMappingRule.defaultTenantRef);
    }

    @Override
    public String toString() {
      StringBuilder sb = new StringBuilder();
      sb.append("class AuthMappingRule {\n");
                  sb.append("    assignPolicy: ").append(toIndentedString(assignPolicy)).append("\n");
                        sb.append("    assignRole: ").append(toIndentedString(assignRole)).append("\n");
                        sb.append("    assignTenant: ").append(toIndentedString(assignTenant)).append("\n");
                        sb.append("    assignUserprofile: ").append(toIndentedString(assignUserprofile)).append("\n");
                        sb.append("    attributeMatch: ").append(toIndentedString(attributeMatch)).append("\n");
                        sb.append("    defaultTenantRef: ").append(toIndentedString(defaultTenantRef)).append("\n");
                        sb.append("    groupMatch: ").append(toIndentedString(groupMatch)).append("\n");
                        sb.append("    index: ").append(toIndentedString(index)).append("\n");
                        sb.append("    isSuperuser: ").append(toIndentedString(isSuperuser)).append("\n");
                        sb.append("    policyAttributeName: ").append(toIndentedString(policyAttributeName)).append("\n");
                        sb.append("    roleAttributeName: ").append(toIndentedString(roleAttributeName)).append("\n");
                        sb.append("    roleRefs: ").append(toIndentedString(roleRefs)).append("\n");
                        sb.append("    tenantAttributeName: ").append(toIndentedString(tenantAttributeName)).append("\n");
                        sb.append("    tenantRefs: ").append(toIndentedString(tenantRefs)).append("\n");
                        sb.append("    userprofileAttributeName: ").append(toIndentedString(userprofileAttributeName)).append("\n");
                        sb.append("    userprofileRef: ").append(toIndentedString(userprofileRef)).append("\n");
                  sb.append("}");
      return sb.toString();
    }

    /**
     * Convert the given object to string with each line indented by 4 spaces
     * (except the first line).
     */
    private String toIndentedString(java.lang.Object o) {
      if (o == null) {
          return "null";
      }
      return o.toString().replace("\n", "\n    ");
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy