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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of element-api Show documentation
Library for interfacing with the Public and Incubating SolidFire Element API.
There is a newer version: 1.0.0.53



/*
 * Copyright © 2015 SolidFire, 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.javautil.Optional;

import com.solidfire.client.ApiException;
import com.solidfire.javautil.Optional;

import java.net.URL;
import java.util.Arrays;
import java.util.Objects;
import com.solidfire.annotation.Since;

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


/**
 * The Request object for the "CreateSnapshot" API Service call.
 **/
public class CreateSnapshotRequest {

    private final Long volumeID;
    private final Optional snapshotID;
    private final Optional name;
    private final Optional enableRemoteReplication;
    private final Optional retention;
    private final Optional> attributes;

    /**
     * The Request object for the "CreateSnapshot" API Service call.
     * @param volumeID [required] ID of the volume image from which to copy.
     * @param snapshotID (optional) Unique ID of a snapshot from which the new snapshot is made.
     * @param name (optional) A name for the snapshot.
     * @param attributes (optional) List of Name/Value pairs in JSON object format.
     * @since 7.0
     **/
    @Since("7.0")
    public CreateSnapshotRequest(Long volumeID, Optional snapshotID, Optional name, Optional> attributes) {
        this.name = name;
        this.attributes = attributes;
        this.retention = null;
        this.enableRemoteReplication = null;
        this.volumeID = volumeID;
        this.snapshotID = snapshotID;
    }

    /**
     * The Request object for the "CreateSnapshot" API Service call.
     * @param volumeID [required] ID of the volume image from which to copy.
     * @param snapshotID (optional) Unique ID of a snapshot from which the new snapshot is made.
     * @param name (optional) A name for the snapshot.
     * @param enableRemoteReplication (optional) Identifies if snapshot is enabled for remote replication.
     * @param retention (optional) The amount of time the snapshot will be retained. Enter in HH:mm:ss
     * @param attributes (optional) List of Name/Value pairs in JSON object format.
     * @since 8.0
     **/
    @Since("8.0")
    public CreateSnapshotRequest(Long volumeID, Optional snapshotID, Optional name, Optional enableRemoteReplication, Optional retention, Optional> attributes) {
        this.name = name;
        this.attributes = attributes;
        this.retention = retention;
        this.enableRemoteReplication = enableRemoteReplication;
        this.volumeID = volumeID;
        this.snapshotID = snapshotID;
    }


    /**
     * ID of the volume image from which to copy.
     **/
    public Long getVolumeID() {
        return this.volumeID;
    }

    /**
     * Unique ID of a snapshot from which the new snapshot is made.
     * The snapshotID passed must be a snapshot on the given volume.
     * If a SnapshotID is not provided, a snapshot is created from the volume's active branch.
     **/
    public Optional getSnapshotID() {
        return this.snapshotID;
    }

    /**
     * A name for the snapshot.
     * If no name is provided, the date and time the snapshot was taken is used.
     **/
    public Optional getName() {
        return this.name;
    }

    /**
     * Identifies if snapshot is enabled for remote replication.
     * @since 8.0 
     **/

    @Since("8.0")
    public Optional getEnableRemoteReplication() {
        return this.enableRemoteReplication;
    }

    /**
     * The amount of time the snapshot will be retained. Enter in HH:mm:ss
     * @since 8.0 
     **/

    @Since("8.0")
    public Optional getRetention() {
        return this.retention;
    }

    /**
     * List of Name/Value pairs in JSON object format.
     **/
    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;

        CreateSnapshotRequest that = (CreateSnapshotRequest) o;
        

        return Objects.equals( volumeID , that.volumeID )
            && Objects.equals( snapshotID , that.snapshotID )
            && Objects.equals( name , that.name )
            && Objects.equals( enableRemoteReplication , that.enableRemoteReplication )
            && Objects.equals( retention , that.retention )
            && Objects.equals( attributes , that.attributes );
    }

    @Override
    public int hashCode() {

        return Objects.hash( volumeID, snapshotID, name, enableRemoteReplication, retention, attributes );
    }


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

        sb.append(" volumeID : ").append(volumeID).append(",");
        if(null != snapshotID && snapshotID.isPresent())
            sb.append(" snapshotID : ").append(snapshotID.get()).append(",");
        if(null != name && name.isPresent())
            sb.append(" name : ").append(name.get()).append(",");
        if(null != enableRemoteReplication && enableRemoteReplication.isPresent())
            sb.append(" enableRemoteReplication : ").append(enableRemoteReplication.get()).append(",");
        if(null != retention && retention.isPresent())
            sb.append(" retention : ").append(retention.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();
    }
}