com.solidfire.element.api.ListVolumesRequest 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
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;
/**
* ListVolumesRequest
* The ListVolumes method enables you to retrieve a list of volumes that are in a cluster. You can specify the volumes you want to
* return in the list by using the available parameters.
**/
public class ListVolumesRequest implements Serializable {
public static final long serialVersionUID = 5183986509019868242L;
@SerializedName("startVolumeID") private Optional startVolumeID;
@SerializedName("limit") private Optional limit;
@SerializedName("volumeStatus") private Optional volumeStatus;
@SerializedName("accounts") private Optional accounts;
@SerializedName("isPaired") private Optional isPaired;
@SerializedName("volumeIDs") private Optional volumeIDs;
@SerializedName("volumeName") private Optional volumeName;
@SerializedName("includeVirtualVolumes") private Optional includeVirtualVolumes;
// empty constructor
@Since("7.0")
public ListVolumesRequest() {}
// parameterized constructor
@Since("7.0")
public ListVolumesRequest(
Optional startVolumeID,
Optional limit,
Optional volumeStatus,
Optional accounts,
Optional isPaired,
Optional volumeName
)
{
this.startVolumeID = (startVolumeID == null) ? Optional.empty() : startVolumeID;
this.limit = (limit == null) ? Optional.empty() : limit;
this.volumeStatus = (volumeStatus == null) ? Optional.empty() : volumeStatus;
this.accounts = (accounts == null) ? Optional.empty() : accounts;
this.isPaired = (isPaired == null) ? Optional.empty() : isPaired;
this.volumeName = (volumeName == null) ? Optional.empty() : volumeName;
}
// parameterized constructor
@Since("9.0")
public ListVolumesRequest(
Optional startVolumeID,
Optional limit,
Optional volumeStatus,
Optional accounts,
Optional isPaired,
Optional volumeIDs,
Optional volumeName,
Optional includeVirtualVolumes
)
{
this.startVolumeID = (startVolumeID == null) ? Optional.empty() : startVolumeID;
this.limit = (limit == null) ? Optional.empty() : limit;
this.volumeStatus = (volumeStatus == null) ? Optional.empty() : volumeStatus;
this.accounts = (accounts == null) ? Optional.empty() : accounts;
this.isPaired = (isPaired == null) ? Optional.empty() : isPaired;
this.volumeIDs = (volumeIDs == null) ? Optional.empty() : volumeIDs;
this.volumeName = (volumeName == null) ? Optional.empty() : volumeName;
this.includeVirtualVolumes = (includeVirtualVolumes == null) ? Optional.empty() : includeVirtualVolumes;
}
/**
* Only volumes with an ID greater than or equal to this
* value are returned. Mutually exclusive with the
* volumeIDs parameter.
**/
public Optional getStartVolumeID() { return this.startVolumeID; }
public void setStartVolumeID(Optional startVolumeID) {
this.startVolumeID = (startVolumeID == null) ? Optional.empty() : startVolumeID;
}
/**
* Specifies the maximum number of volume
* results that are returned. Mutually exclusive with the
* volumeIDs parameter.
**/
public Optional getLimit() { return this.limit; }
public void setLimit(Optional limit) {
this.limit = (limit == null) ? Optional.empty() : limit;
}
/**
* Only volumes with a status equal to the status value are
* returned.
* Possible values are:
* creating
* snapshotting
* active
* deleted
**/
public Optional getVolumeStatus() { return this.volumeStatus; }
public void setVolumeStatus(Optional volumeStatus) {
this.volumeStatus = (volumeStatus == null) ? Optional.empty() : volumeStatus;
}
/**
* Returns only the volumes owned by the accounts you specify here. Mutually exclusive with the volumeIDs parameter.
**/
public Optional getAccounts() { return this.accounts; }
public void setAccounts(Optional accounts) {
this.accounts = (accounts == null) ? Optional.empty() : accounts;
}
/**
* Returns volumes that are paired or not paired.
* Possible values are:
* true: Returns all paired volumes.
* false: Returns all volumes that are not paired.
**/
public Optional getIsPaired() { return this.isPaired; }
public void setIsPaired(Optional isPaired) {
this.isPaired = (isPaired == null) ? Optional.empty() : isPaired;
}
/**
* A list of volume IDs. If you supply this parameter, other
* parameters operate only on this set of volumes. Mutually
* exclusive with the accounts, startVolumeID, and limit
* parameters.
**/
public Optional getVolumeIDs() { return this.volumeIDs; }
public void setVolumeIDs(Optional volumeIDs) {
this.volumeIDs = (volumeIDs == null) ? Optional.empty() : volumeIDs;
}
/**
* Only volume object information matching the volume
* name is returned.
**/
public Optional getVolumeName() { return this.volumeName; }
public void setVolumeName(Optional volumeName) {
this.volumeName = (volumeName == null) ? Optional.empty() : volumeName;
}
/**
* Specifies that virtual volumes are included in the response by default.
* To exclude virtual volumes, set to false.
**/
public Optional getIncludeVirtualVolumes() { return this.includeVirtualVolumes; }
public void setIncludeVirtualVolumes(Optional includeVirtualVolumes) {
this.includeVirtualVolumes = (includeVirtualVolumes == null) ? Optional.empty() : includeVirtualVolumes;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ListVolumesRequest that = (ListVolumesRequest) o;
return
Objects.equals(startVolumeID, that.startVolumeID) &&
Objects.equals(limit, that.limit) &&
Objects.equals(volumeStatus, that.volumeStatus) &&
Objects.equals(accounts, that.accounts) &&
Objects.equals(isPaired, that.isPaired) &&
Objects.equals(volumeIDs, that.volumeIDs) &&
Objects.equals(volumeName, that.volumeName) &&
Objects.equals(includeVirtualVolumes, that.includeVirtualVolumes);
}
@Override
public int hashCode() {
return Objects.hash( startVolumeID,limit,volumeStatus,accounts,isPaired,volumeIDs,volumeName,includeVirtualVolumes );
}
public java.util.Map toMap() {
java.util.Map map = new HashMap<>();
map.put("startVolumeID", startVolumeID);
map.put("limit", limit);
map.put("volumeStatus", volumeStatus);
map.put("accounts", accounts);
map.put("isPaired", isPaired);
map.put("volumeIDs", volumeIDs);
map.put("volumeName", volumeName);
map.put("includeVirtualVolumes", includeVirtualVolumes);
return map;
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
Gson gson = new Gson();
sb.append( "{ " );
if(null != startVolumeID && startVolumeID.isPresent()){
sb.append(" startVolumeID : ").append(gson.toJson(startVolumeID)).append(",");
}
else{
sb.append(" startVolumeID : ").append("null").append(",");
}
if(null != limit && limit.isPresent()){
sb.append(" limit : ").append(gson.toJson(limit)).append(",");
}
else{
sb.append(" limit : ").append("null").append(",");
}
if(null != volumeStatus && volumeStatus.isPresent()){
sb.append(" volumeStatus : ").append(gson.toJson(volumeStatus)).append(",");
}
else{
sb.append(" volumeStatus : ").append("null").append(",");
}
if(null != accounts && accounts.isPresent()){
sb.append(" accounts : ").append(gson.toJson(accounts)).append(",");
}
else{
sb.append(" accounts : ").append("null").append(",");
}
if(null != isPaired && isPaired.isPresent()){
sb.append(" isPaired : ").append(gson.toJson(isPaired)).append(",");
}
else{
sb.append(" isPaired : ").append("null").append(",");
}
if(null != volumeIDs && volumeIDs.isPresent()){
sb.append(" volumeIDs : ").append(gson.toJson(volumeIDs)).append(",");
}
else{
sb.append(" volumeIDs : ").append("null").append(",");
}
if(null != volumeName && volumeName.isPresent()){
sb.append(" volumeName : ").append(gson.toJson(volumeName)).append(",");
}
else{
sb.append(" volumeName : ").append("null").append(",");
}
if(null != includeVirtualVolumes && includeVirtualVolumes.isPresent()){
sb.append(" includeVirtualVolumes : ").append(gson.toJson(includeVirtualVolumes)).append(",");
}
else{
sb.append(" includeVirtualVolumes : ").append("null").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 Optional startVolumeID;
private Optional limit;
private Optional volumeStatus;
private Optional accounts;
private Optional isPaired;
private Optional volumeIDs;
private Optional volumeName;
private Optional includeVirtualVolumes;
private Builder() { }
public ListVolumesRequest build() {
return new ListVolumesRequest (
this.startVolumeID,
this.limit,
this.volumeStatus,
this.accounts,
this.isPaired,
this.volumeIDs,
this.volumeName,
this.includeVirtualVolumes);
}
private ListVolumesRequest.Builder buildFrom(final ListVolumesRequest req) {
this.startVolumeID = req.startVolumeID;
this.limit = req.limit;
this.volumeStatus = req.volumeStatus;
this.accounts = req.accounts;
this.isPaired = req.isPaired;
this.volumeIDs = req.volumeIDs;
this.volumeName = req.volumeName;
this.includeVirtualVolumes = req.includeVirtualVolumes;
return this;
}
public ListVolumesRequest.Builder optionalStartVolumeID(final Long startVolumeID) {
this.startVolumeID = (startVolumeID == null) ? Optional.empty() : Optional.of(startVolumeID);
return this;
}
public ListVolumesRequest.Builder optionalLimit(final Long limit) {
this.limit = (limit == null) ? Optional.empty() : Optional.of(limit);
return this;
}
public ListVolumesRequest.Builder optionalVolumeStatus(final String volumeStatus) {
this.volumeStatus = (volumeStatus == null) ? Optional.empty() : Optional.of(volumeStatus);
return this;
}
public ListVolumesRequest.Builder optionalAccounts(final Long[] accounts) {
this.accounts = (accounts == null) ? Optional.empty() : Optional.of(accounts);
return this;
}
public ListVolumesRequest.Builder optionalIsPaired(final Boolean isPaired) {
this.isPaired = (isPaired == null) ? Optional.empty() : Optional.of(isPaired);
return this;
}
public ListVolumesRequest.Builder optionalVolumeIDs(final Long[] volumeIDs) {
this.volumeIDs = (volumeIDs == null) ? Optional.empty() : Optional.of(volumeIDs);
return this;
}
public ListVolumesRequest.Builder optionalVolumeName(final String volumeName) {
this.volumeName = (volumeName == null) ? Optional.empty() : Optional.of(volumeName);
return this;
}
public ListVolumesRequest.Builder optionalIncludeVirtualVolumes(final Boolean includeVirtualVolumes) {
this.includeVirtualVolumes = (includeVirtualVolumes == null) ? Optional.empty() : Optional.of(includeVirtualVolumes);
return this;
}
}
}