com.solidfire.element.api.QoS 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.
/*
* 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;
/**
* Quality of Service (QoS) values are used on SolidFire volumes to provision performance expectations.
**/
public class QoS implements Serializable {
private static final long serialVersionUID = -79923561L;
@SerializedName("minIOPS") private final Optional minIOPS;
@SerializedName("maxIOPS") private final Optional maxIOPS;
@SerializedName("burstIOPS") private final Optional burstIOPS;
@SerializedName("burstTime") private final Optional burstTime;
/**
* Quality of Service (QoS) values are used on SolidFire volumes to provision performance expectations.
* Minimum, maximum and burst QoS values can be set within the ranges specified in the QoS table below.
*
* Volumes created without specified QoS values are created with the Default values listed below.
* Default values can be found by running the GetDefaultQoS method.
*
* minIOPS Min: 100/50 (v7.0/v8.0), Default: 100, Max: 15,000
* maxIOPS Min: 100/50 (v7.0/v8.0), Default: 15,000, Max: 100,000
* burstIOPS Min: 100/50 (v7.0/v8.0), Default: 15,000, Max: 100,000
* @param minIOPS (optional) Desired minimum 4KB IOPS to guarantee.
* @param maxIOPS (optional) Desired maximum 4KB IOPS allowed over an extended period of time.
* @param burstIOPS (optional) Maximum "peak" 4KB IOPS allowed for short periods of time.
* @param burstTime (optional) The length of time burst IOPS is allowed.
* @since 7.0
**/
@Since("7.0")
public QoS(Optional minIOPS, Optional maxIOPS, Optional burstIOPS, Optional burstTime) {
this.minIOPS = (minIOPS == null) ? Optional.empty() : minIOPS;
this.maxIOPS = (maxIOPS == null) ? Optional.empty() : maxIOPS;
this.burstIOPS = (burstIOPS == null) ? Optional.empty() : burstIOPS;
this.burstTime = (burstTime == null) ? Optional.empty() : burstTime;
}
/**
* Desired minimum 4KB IOPS to guarantee.
* The allowed IOPS will only drop below this level if all volumes have been capped
* at their minimum IOPS value and there is still insufficient performance capacity.
**/
public Optional getMinIOPS() {
return this.minIOPS;
}
/**
* Desired maximum 4KB IOPS allowed over an extended period of time.
**/
public Optional getMaxIOPS() {
return this.maxIOPS;
}
/**
* Maximum "peak" 4KB IOPS allowed for short periods of time.
* Allows for bursts of I/O activity over the normal max IOPS value.
**/
public Optional getBurstIOPS() {
return this.burstIOPS;
}
/**
* The length of time burst IOPS is allowed.
* The value returned is represented in time units of seconds.
*
Note: this value is calculated by the system based on IOPS set for QoS.
**/
public Optional getBurstTime() {
return this.burstTime;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
QoS that = (QoS) o;
return Objects.equals( minIOPS , that.minIOPS )
&& Objects.equals( maxIOPS , that.maxIOPS )
&& Objects.equals( burstIOPS , that.burstIOPS )
&& Objects.equals( burstTime , that.burstTime );
}
@Override
public int hashCode() {
return Objects.hash( minIOPS, maxIOPS, burstIOPS, burstTime );
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append( "{ " );
if(null != minIOPS && minIOPS.isPresent())
sb.append(" minIOPS : ").append(minIOPS.get()).append(",");
if(null != maxIOPS && maxIOPS.isPresent())
sb.append(" maxIOPS : ").append(maxIOPS.get()).append(",");
if(null != burstIOPS && burstIOPS.isPresent())
sb.append(" burstIOPS : ").append(burstIOPS.get()).append(",");
if(null != burstTime && burstTime.isPresent())
sb.append(" burstTime : ").append(burstTime.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 Optional minIOPS;
private Optional maxIOPS;
private Optional burstIOPS;
private Optional burstTime;
private Builder() { }
public QoS build() {
return new QoS (
this.minIOPS,
this.maxIOPS,
this.burstIOPS,
this.burstTime );
}
private QoS.Builder buildFrom(final QoS req) {
this.minIOPS = req.minIOPS;
this.maxIOPS = req.maxIOPS;
this.burstIOPS = req.burstIOPS;
this.burstTime = req.burstTime;
return this;
}
public QoS.Builder optionalMinIOPS(final Long minIOPS) {
this.minIOPS = (minIOPS == null) ? Optional.empty() : Optional.of(minIOPS);
return this;
}
public QoS.Builder optionalMaxIOPS(final Long maxIOPS) {
this.maxIOPS = (maxIOPS == null) ? Optional.empty() : Optional.of(maxIOPS);
return this;
}
public QoS.Builder optionalBurstIOPS(final Long burstIOPS) {
this.burstIOPS = (burstIOPS == null) ? Optional.empty() : Optional.of(burstIOPS);
return this;
}
public QoS.Builder optionalBurstTime(final Long burstTime) {
this.burstTime = (burstTime == null) ? Optional.empty() : Optional.of(burstTime);
return this;
}
}
}