com.solidfire.element.api.SnmpV3UsmUser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of solidfire-sdk-java Show documentation
Library for interfacing with the Public and Incubating SolidFire Element API.
There is a newer version: 1.5.0.89
/*
 * Copyright © 2014-2016 NetApp, Inc. 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.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 */
/*
 * DO NOT EDIT THIS CODE BY HAND! It has been generated with jsvcgen.
 */
package com.solidfire.element.api;

import com.google.gson.annotations.SerializedName;
import com.solidfire.jsvcgen.annotation.Since;
import com.solidfire.jsvcgen.client.ApiException;
import com.solidfire.jsvcgen.javautil.Optional;

import java.net.URL;

import java.io.Serializable;

import java.util.Arrays;
import java.util.Objects;
import java.util.TreeMap;

import static com.solidfire.jsvcgen.javautil.Optional.of;


/**
 * The SNMP v3 usmUser object is used with the API method SetSnmpInfo to configure SNMP on the cluster.
 **/
public class SnmpV3UsmUser  implements Serializable  {

    private static final long serialVersionUID = -2017812210L;

    @SerializedName("access") private final String access;
    @SerializedName("name") private final String name;
    @SerializedName("password") private final String password;
    @SerializedName("passphrase") private final String passphrase;
    @SerializedName("secLevel") private final String secLevel;

    /**
     * The SNMP v3 usmUser object is used with the API method SetSnmpInfo to configure SNMP on the cluster.
     * @param access [required] 
rouser: read-only access.*
     * @param name [required] The name of the user. Must contain at least one character, but no more than 32 characters. Blank spaces are not allowed.
     * @param password [required] The password of the user. Must be between 8 and 255 characters long (inclusive). Blank spaces are not allowed. Required if "secLevel" is "auth" or "priv."
     * @param passphrase [required] The passphrase of the user. Must be between 8 and 255 characters long (inclusive). Blank spaces are not allowed. Required if "secLevel" is "priv."
     * @param secLevel [required] 
noauth: No password or passphrase is required.
     * @since 7.0
     **/
    @Since("7.0")
    public SnmpV3UsmUser(String access, String name, String password, String passphrase, String secLevel) {
        this.name = name;
        this.passphrase = passphrase;
        this.secLevel = secLevel;
        this.access = access;
        this.password = password;
    }


    /**
     * 
rouser: read-only access.*
     * 
rwuser: for read-write access.
     * 
rosys: for read-only access to a restricted set of system information
     * *SolidFire recommends that all USM users be set to "rouser" access, because all SolidFire MIB objects are read-only.
     **/
    public String getAccess() {
        return this.access;
    }

    /**
     * The name of the user. Must contain at least one character, but no more than 32 characters. Blank spaces are not allowed.
     **/
    public String getName() {
        return this.name;
    }

    /**
     * The password of the user. Must be between 8 and 255 characters long (inclusive). Blank spaces are not allowed. Required if "secLevel" is "auth" or "priv."
     **/
    public String getPassword() {
        return this.password;
    }

    /**
     * The passphrase of the user. Must be between 8 and 255 characters long (inclusive). Blank spaces are not allowed. Required if "secLevel" is "priv."
     **/
    public String getPassphrase() {
        return this.passphrase;
    }

    /**
     * 
noauth: No password or passphrase is required.
     * 
auth: A password is required for user access.
     * 
priv: A password and passphrase is required for user access.
     **/
    public String getSecLevel() {
        return this.secLevel;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        SnmpV3UsmUser that = (SnmpV3UsmUser) o;
        

        return Objects.equals( access , that.access )
            && Objects.equals( name , that.name )
            && Objects.equals( password , that.password )
            && Objects.equals( passphrase , that.passphrase )
            && Objects.equals( secLevel , that.secLevel );
    }

    @Override
    public int hashCode() {
        return Objects.hash( access, name, password, passphrase, secLevel );
    }


    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder();
        sb.append( "{ " );

        sb.append(" access : ").append(access).append(",");
        sb.append(" name : ").append(name).append(",");
        sb.append(" password : ").append(password).append(",");
        sb.append(" passphrase : ").append(passphrase).append(",");
        sb.append(" secLevel : ").append(secLevel);
        sb.append( " }" );

        if(sb.lastIndexOf(", }") != -1)
            sb.deleteCharAt(sb.lastIndexOf(", }"));

        return sb.toString();
    }

    public static Builder builder() {
        return new Builder();
    }

    public final Builder asBuilder() {
        return new Builder().buildFrom(this);
    }

    public static class Builder {
        private String access;
        private String name;
        private String password;
        private String passphrase;
        private String secLevel;

        private Builder() { }

        public SnmpV3UsmUser build() {
            return new SnmpV3UsmUser (
                         this.access,
                         this.name,
                         this.password,
                         this.passphrase,
                         this.secLevel            );
        }

        private SnmpV3UsmUser.Builder buildFrom(final SnmpV3UsmUser req) {
            this.access = req.access;
            this.name = req.name;
            this.password = req.password;
            this.passphrase = req.passphrase;
            this.secLevel = req.secLevel;

            return this;
        }

        public SnmpV3UsmUser.Builder access(final String access) {
            this.access = access;
            return this;
        }

        public SnmpV3UsmUser.Builder name(final String name) {
            this.name = name;
            return this;
        }

        public SnmpV3UsmUser.Builder password(final String password) {
            this.password = password;
            return this;
        }

        public SnmpV3UsmUser.Builder passphrase(final String passphrase) {
            this.passphrase = passphrase;
            return this;
        }

        public SnmpV3UsmUser.Builder secLevel(final String secLevel) {
            this.secLevel = secLevel;
            return this;
        }

    }

}