com.solidfire.element.api.ModifyInitiatorsRequest 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.
The newest version!
/*
 * 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.solidfire.gson.Gson;
import com.solidfire.core.client.Attributes;
import com.solidfire.gson.annotations.SerializedName;
import com.solidfire.core.annotation.Since;
import com.solidfire.core.javautil.Optional;
import java.io.Serializable;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Objects;

/**
 * ModifyInitiatorsRequest  
 * ModifyInitiators enables you to change the attributes of one or more existing initiators. You cannot change the name of an existing
 * initiator. If you need to change the name of an initiator, delete it first with DeleteInitiators and create a new one with
 * CreateInitiators.
 * If ModifyInitiators fails to change one of the initiators provided in the parameter, the method returns an error and does not modify
 * any initiators (no partial completion is possible).
 **/

public class ModifyInitiatorsRequest implements Serializable {

    public static final long serialVersionUID = -2269498454565308820L;
    @SerializedName("initiators") private ModifyInitiator[] initiators;
    // empty constructor
    @Since("7.0")
    public ModifyInitiatorsRequest() {}

    
    // parameterized constructor
    @Since("7.0")
    public ModifyInitiatorsRequest(
        ModifyInitiator[] initiators
    )
    {
        this.initiators = initiators;
    }

    /** 
     * A list of objects containing characteristics of each initiator to modify. Values are:
     * initiatorID: (Required) The ID of the initiator to modify. (Integer)
     * alias: (Optional) A new friendly name to assign to the initiator.
     * (String)
     * attributes: (Optional) A new set of JSON attributes to assign to the
     * initiator. (JSON Object)
     * volumeAccessGroupID: (Optional) The ID of the volume access
     * group into to which the initiator should be added. If the initiator was
     * previously in a different volume access group, it is removed from the
     * old volume access group. If this key is present but null, the initiator is
     * removed from its current volume access group, but not placed in any
     * new volume access group. (Integer)
     **/
    public ModifyInitiator[] getInitiators() { return this.initiators; }
   
    public void setInitiators(ModifyInitiator[] initiators) { 
        this.initiators = initiators;
    }

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

        ModifyInitiatorsRequest that = (ModifyInitiatorsRequest) o;

        return 
            Arrays.equals(initiators, that.initiators);
    }

    @Override
    public int hashCode() {
        return Objects.hash( (Object[])initiators );
    }


    public java.util.Map toMap() {
        java.util.Map map = new HashMap<>();
        map.put("initiators", initiators);
        return map;
    }

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

        sb.append(" initiators : ").append(gson.toJson(Arrays.toString(initiators))).append(",");
        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 ModifyInitiator[] initiators;

        private Builder() { }

        public ModifyInitiatorsRequest build() {
            return new ModifyInitiatorsRequest (
                         this.initiators);
        }

        private ModifyInitiatorsRequest.Builder buildFrom(final ModifyInitiatorsRequest req) {
            this.initiators = req.initiators;

            return this;
        }

        public ModifyInitiatorsRequest.Builder initiators(final ModifyInitiator[] initiators) {
            this.initiators = initiators;
            return this;
        }

    }
}