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

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

Go to download

Library for interfacing with the Public and Incubating SolidFire Element API.

There is a newer version: 1.5.0.89
Show 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.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 Request object for the "StartBulkVolumeRead" API Service call.
 **/
public class StartBulkVolumeReadRequest  implements Serializable  {

    private static final long serialVersionUID = -953327189L;

    @SerializedName("volumeID") private final Long volumeID;
    @SerializedName("format") private final String format;
    @SerializedName("snapshotID") private final Optional snapshotID;
    @SerializedName("script") private final Optional script;
    @SerializedName("scriptParameters") private final Optional scriptParameters;
    @SerializedName("attributes") private final Optional> attributes;

    /**
     * The Request object for the "StartBulkVolumeRead" API Service call.
     * @param volumeID [required] ID of the volume to be read.
     * @param format [required] The format of the volume data. Can be either:
     * @param snapshotID (optional) ID of a previously created snapshot used for bulk volume reads.
     * @param script (optional) Executable name of a script.
     * @param scriptParameters (optional) JSON parameters to pass to the script.
     * @param attributes (optional) JSON attributes for the bulk volume job.
     * @since 7.0
     **/
    @Since("7.0")
    public StartBulkVolumeReadRequest(Long volumeID, String format, Optional snapshotID, Optional script, Optional scriptParameters, Optional> attributes) {
        this.format = format;
        this.attributes = (attributes == null) ? Optional.>empty() : attributes;
        this.volumeID = volumeID;
        this.script = (script == null) ? Optional.empty() : script;
        this.snapshotID = (snapshotID == null) ? Optional.empty() : snapshotID;
        this.scriptParameters = (scriptParameters == null) ? Optional.empty() : scriptParameters;
    }


    /**
     * ID of the volume to be read.
     **/
    public Long getVolumeID() {
        return this.volumeID;
    }

    /**
     * The format of the volume data. Can be either:
     * 
uncompressed: every byte of the volume is returned without any compression.
     * 
native: opaque data is returned that is smaller and more efficiently stored and written on a subsequent bulk volume write.
     **/
    public String getFormat() {
        return this.format;
    }

    /**
     * ID of a previously created snapshot used for bulk volume reads.
     * If no ID is entered, a snapshot of the current active volume image is made.
     **/
    public Optional getSnapshotID() {
        return this.snapshotID;
    }

    /**
     * Executable name of a script.
     * If no script name is given then the key and URL is necessary to access SolidFire nodes.
     * The script is run on the primary node and the key and URL is returned to the script so the local web server can be contacted.
     **/
    public Optional getScript() {
        return this.script;
    }

    /**
     * JSON parameters to pass to the script.
     **/
    public Optional getScriptParameters() {
        return this.scriptParameters;
    }

    /**
     * JSON attributes for the bulk volume job.
     **/
    public Optional> getAttributes() {
        return this.attributes;
    }

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

        StartBulkVolumeReadRequest that = (StartBulkVolumeReadRequest) o;
        

        return Objects.equals( volumeID , that.volumeID )
            && Objects.equals( format , that.format )
            && Objects.equals( snapshotID , that.snapshotID )
            && Objects.equals( script , that.script )
            && Objects.equals( scriptParameters , that.scriptParameters )
            && Objects.equals( attributes , that.attributes );
    }

    @Override
    public int hashCode() {
        return Objects.hash( volumeID, format, snapshotID, script, scriptParameters, attributes );
    }


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

        sb.append(" volumeID : ").append(volumeID).append(",");
        sb.append(" format : ").append(format).append(",");
        if(null != snapshotID && snapshotID.isPresent())
            sb.append(" snapshotID : ").append(snapshotID.get()).append(",");
        if(null != script && script.isPresent())
            sb.append(" script : ").append(script.get()).append(",");
        if(null != scriptParameters && scriptParameters.isPresent())
            sb.append(" scriptParameters : ").append(scriptParameters.get()).append(",");
        if(null != attributes && attributes.isPresent())
            sb.append(" attributes : ").append(attributes.get());
        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 Long volumeID;
        private String format;
        private Optional snapshotID;
        private Optional script;
        private Optional scriptParameters;
        private Optional> attributes;

        private Builder() { }

        public StartBulkVolumeReadRequest build() {
            return new StartBulkVolumeReadRequest (
                         this.volumeID,
                         this.format,
                         this.snapshotID,
                         this.script,
                         this.scriptParameters,
                         this.attributes            );
        }

        private StartBulkVolumeReadRequest.Builder buildFrom(final StartBulkVolumeReadRequest req) {
            this.volumeID = req.volumeID;
            this.format = req.format;
            this.snapshotID = req.snapshotID;
            this.script = req.script;
            this.scriptParameters = req.scriptParameters;
            this.attributes = req.attributes;

            return this;
        }

        public StartBulkVolumeReadRequest.Builder volumeID(final Long volumeID) {
            this.volumeID = volumeID;
            return this;
        }

        public StartBulkVolumeReadRequest.Builder format(final String format) {
            this.format = format;
            return this;
        }

        public StartBulkVolumeReadRequest.Builder optionalSnapshotID(final Long snapshotID) {
            this.snapshotID = (snapshotID == null) ? Optional.empty() : Optional.of(snapshotID);
            return this;
        }

        public StartBulkVolumeReadRequest.Builder optionalScript(final String script) {
            this.script = (script == null) ? Optional.empty() : Optional.of(script);
            return this;
        }

        public StartBulkVolumeReadRequest.Builder optionalScriptParameters(final Object scriptParameters) {
            this.scriptParameters = (scriptParameters == null) ? Optional.empty() : Optional.of(scriptParameters);
            return this;
        }

        public StartBulkVolumeReadRequest.Builder optionalAttributes(final java.util.Map attributes) {
            this.attributes = (attributes == null) ? Optional.>empty() : Optional.of(attributes);
            return this;
        }

    }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy