get_api_24_arrays_performance_parameters.go

// Code generated by go-swagger; DO NOT EDIT.

package arrays

// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command

import (
	"context"
	"net/http"
	"time"

	"github.com/go-openapi/errors"
	"github.com/go-openapi/runtime"
	cr "github.com/go-openapi/runtime/client"
	"github.com/go-openapi/strfmt"
	"github.com/go-openapi/swag"
)

// NewGetAPI24ArraysPerformanceParams creates a new GetAPI24ArraysPerformanceParams object
// with the default values initialized.
func NewGetAPI24ArraysPerformanceParams() *GetAPI24ArraysPerformanceParams {
	var ()
	return &GetAPI24ArraysPerformanceParams{

		timeout: cr.DefaultTimeout,
	}
}

// NewGetAPI24ArraysPerformanceParamsWithTimeout creates a new GetAPI24ArraysPerformanceParams object
// with the default values initialized, and the ability to set a timeout on a request
func NewGetAPI24ArraysPerformanceParamsWithTimeout(timeout time.Duration) *GetAPI24ArraysPerformanceParams {
	var ()
	return &GetAPI24ArraysPerformanceParams{

		timeout: timeout,
	}
}

// NewGetAPI24ArraysPerformanceParamsWithContext creates a new GetAPI24ArraysPerformanceParams object
// with the default values initialized, and the ability to set a context for a request
func NewGetAPI24ArraysPerformanceParamsWithContext(ctx context.Context) *GetAPI24ArraysPerformanceParams {
	var ()
	return &GetAPI24ArraysPerformanceParams{

		Context: ctx,
	}
}

// NewGetAPI24ArraysPerformanceParamsWithHTTPClient creates a new GetAPI24ArraysPerformanceParams object
// with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewGetAPI24ArraysPerformanceParamsWithHTTPClient(client *http.Client) *GetAPI24ArraysPerformanceParams {
	var ()
	return &GetAPI24ArraysPerformanceParams{
		HTTPClient: client,
	}
}

/*GetAPI24ArraysPerformanceParams contains all the parameters to send to the API endpoint
for the get API 24 arrays performance operation typically these are written to a http.Request
*/
type GetAPI24ArraysPerformanceParams struct {

	/*Authorization
	  Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)

	*/
	Authorization *string
	/*XRequestID
	  Supplied by client during request or generated by server.

	*/
	XRequestID *string
	/*EndTime
	  Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.

	*/
	EndTime *int64
	/*Filter
	  Narrows down the results to only the response objects that satisfy the filter criteria.

	*/
	Filter *string
	/*Limit
	  Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

	*/
	Limit *int32
	/*Offset
	  The starting position based on the results of the query in relation to the full set of response objects returned.

	*/
	Offset *int32
	/*Protocol
	  Protocol type. Valid values are `nfs`, `smb`, and `all`.

	*/
	Protocol *string
	/*ProtocolGroup
	  Protocol group type. Valid values are `block`, `file`, and `all`.

	*/
	ProtocolGroup *string
	/*Resolution
	  The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`<object name>/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`<object name>/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution.

	*/
	Resolution *int64
	/*Sort
	  Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

	*/
	Sort []string
	/*StartTime
	  Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution.

	*/
	StartTime *int64
	/*TotalItemCount
	  If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

	*/
	TotalItemCount *bool

	timeout    time.Duration
	Context    context.Context
	HTTPClient *http.Client
}

// WithTimeout adds the timeout to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithTimeout(timeout time.Duration) *GetAPI24ArraysPerformanceParams {
	o.SetTimeout(timeout)
	return o
}

// SetTimeout adds the timeout to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetTimeout(timeout time.Duration) {
	o.timeout = timeout
}

// WithContext adds the context to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithContext(ctx context.Context) *GetAPI24ArraysPerformanceParams {
	o.SetContext(ctx)
	return o
}

// SetContext adds the context to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetContext(ctx context.Context) {
	o.Context = ctx
}

// WithHTTPClient adds the HTTPClient to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithHTTPClient(client *http.Client) *GetAPI24ArraysPerformanceParams {
	o.SetHTTPClient(client)
	return o
}

// SetHTTPClient adds the HTTPClient to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetHTTPClient(client *http.Client) {
	o.HTTPClient = client
}

// WithAuthorization adds the authorization to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithAuthorization(authorization *string) *GetAPI24ArraysPerformanceParams {
	o.SetAuthorization(authorization)
	return o
}

// SetAuthorization adds the authorization to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetAuthorization(authorization *string) {
	o.Authorization = authorization
}

// WithXRequestID adds the xRequestID to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithXRequestID(xRequestID *string) *GetAPI24ArraysPerformanceParams {
	o.SetXRequestID(xRequestID)
	return o
}

// SetXRequestID adds the xRequestId to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetXRequestID(xRequestID *string) {
	o.XRequestID = xRequestID
}

// WithEndTime adds the endTime to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithEndTime(endTime *int64) *GetAPI24ArraysPerformanceParams {
	o.SetEndTime(endTime)
	return o
}

// SetEndTime adds the endTime to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetEndTime(endTime *int64) {
	o.EndTime = endTime
}

// WithFilter adds the filter to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithFilter(filter *string) *GetAPI24ArraysPerformanceParams {
	o.SetFilter(filter)
	return o
}

// SetFilter adds the filter to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetFilter(filter *string) {
	o.Filter = filter
}

// WithLimit adds the limit to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithLimit(limit *int32) *GetAPI24ArraysPerformanceParams {
	o.SetLimit(limit)
	return o
}

// SetLimit adds the limit to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetLimit(limit *int32) {
	o.Limit = limit
}

// WithOffset adds the offset to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithOffset(offset *int32) *GetAPI24ArraysPerformanceParams {
	o.SetOffset(offset)
	return o
}

// SetOffset adds the offset to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetOffset(offset *int32) {
	o.Offset = offset
}

// WithProtocol adds the protocol to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithProtocol(protocol *string) *GetAPI24ArraysPerformanceParams {
	o.SetProtocol(protocol)
	return o
}

// SetProtocol adds the protocol to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetProtocol(protocol *string) {
	o.Protocol = protocol
}

// WithProtocolGroup adds the protocolGroup to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithProtocolGroup(protocolGroup *string) *GetAPI24ArraysPerformanceParams {
	o.SetProtocolGroup(protocolGroup)
	return o
}

// SetProtocolGroup adds the protocolGroup to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetProtocolGroup(protocolGroup *string) {
	o.ProtocolGroup = protocolGroup
}

// WithResolution adds the resolution to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithResolution(resolution *int64) *GetAPI24ArraysPerformanceParams {
	o.SetResolution(resolution)
	return o
}

// SetResolution adds the resolution to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetResolution(resolution *int64) {
	o.Resolution = resolution
}

// WithSort adds the sort to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithSort(sort []string) *GetAPI24ArraysPerformanceParams {
	o.SetSort(sort)
	return o
}

// SetSort adds the sort to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetSort(sort []string) {
	o.Sort = sort
}

// WithStartTime adds the startTime to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithStartTime(startTime *int64) *GetAPI24ArraysPerformanceParams {
	o.SetStartTime(startTime)
	return o
}

// SetStartTime adds the startTime to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetStartTime(startTime *int64) {
	o.StartTime = startTime
}

// WithTotalItemCount adds the totalItemCount to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) WithTotalItemCount(totalItemCount *bool) *GetAPI24ArraysPerformanceParams {
	o.SetTotalItemCount(totalItemCount)
	return o
}

// SetTotalItemCount adds the totalItemCount to the get API 24 arrays performance params
func (o *GetAPI24ArraysPerformanceParams) SetTotalItemCount(totalItemCount *bool) {
	o.TotalItemCount = totalItemCount
}

// WriteToRequest writes these params to a swagger request
func (o *GetAPI24ArraysPerformanceParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error {

	if err := r.SetTimeout(o.timeout); err != nil {
		return err
	}
	var res []error

	if o.Authorization != nil {

		// header param Authorization
		if err := r.SetHeaderParam("Authorization", *o.Authorization); err != nil {
			return err
		}

	}

	if o.XRequestID != nil {

		// header param X-Request-ID
		if err := r.SetHeaderParam("X-Request-ID", *o.XRequestID); err != nil {
			return err
		}

	}

	if o.EndTime != nil {

		// query param end_time
		var qrEndTime int64
		if o.EndTime != nil {
			qrEndTime = *o.EndTime
		}
		qEndTime := swag.FormatInt64(qrEndTime)
		if qEndTime != "" {

			if err := r.SetQueryParam("end_time", qEndTime); err != nil {
				return err
			}
		}

	}

	if o.Filter != nil {

		// query param filter
		var qrFilter string
		if o.Filter != nil {
			qrFilter = *o.Filter
		}
		qFilter := qrFilter
		if qFilter != "" {

			if err := r.SetQueryParam("filter", qFilter); err != nil {
				return err
			}
		}

	}

	if o.Limit != nil {

		// query param limit
		var qrLimit int32
		if o.Limit != nil {
			qrLimit = *o.Limit
		}
		qLimit := swag.FormatInt32(qrLimit)
		if qLimit != "" {

			if err := r.SetQueryParam("limit", qLimit); err != nil {
				return err
			}
		}

	}

	if o.Offset != nil {

		// query param offset
		var qrOffset int32
		if o.Offset != nil {
			qrOffset = *o.Offset
		}
		qOffset := swag.FormatInt32(qrOffset)
		if qOffset != "" {

			if err := r.SetQueryParam("offset", qOffset); err != nil {
				return err
			}
		}

	}

	if o.Protocol != nil {

		// query param protocol
		var qrProtocol string
		if o.Protocol != nil {
			qrProtocol = *o.Protocol
		}
		qProtocol := qrProtocol
		if qProtocol != "" {

			if err := r.SetQueryParam("protocol", qProtocol); err != nil {
				return err
			}
		}

	}

	if o.ProtocolGroup != nil {

		// query param protocol_group
		var qrProtocolGroup string
		if o.ProtocolGroup != nil {
			qrProtocolGroup = *o.ProtocolGroup
		}
		qProtocolGroup := qrProtocolGroup
		if qProtocolGroup != "" {

			if err := r.SetQueryParam("protocol_group", qProtocolGroup); err != nil {
				return err
			}
		}

	}

	if o.Resolution != nil {

		// query param resolution
		var qrResolution int64
		if o.Resolution != nil {
			qrResolution = *o.Resolution
		}
		qResolution := swag.FormatInt64(qrResolution)
		if qResolution != "" {

			if err := r.SetQueryParam("resolution", qResolution); err != nil {
				return err
			}
		}

	}

	valuesSort := o.Sort

	joinedSort := swag.JoinByFormat(valuesSort, "csv")
	// query array param sort
	if err := r.SetQueryParam("sort", joinedSort...); err != nil {
		return err
	}

	if o.StartTime != nil {

		// query param start_time
		var qrStartTime int64
		if o.StartTime != nil {
			qrStartTime = *o.StartTime
		}
		qStartTime := swag.FormatInt64(qrStartTime)
		if qStartTime != "" {

			if err := r.SetQueryParam("start_time", qStartTime); err != nil {
				return err
			}
		}

	}

	if o.TotalItemCount != nil {

		// query param total_item_count
		var qrTotalItemCount bool
		if o.TotalItemCount != nil {
			qrTotalItemCount = *o.TotalItemCount
		}
		qTotalItemCount := swag.FormatBool(qrTotalItemCount)
		if qTotalItemCount != "" {

			if err := r.SetQueryParam("total_item_count", qTotalItemCount); err != nil {
				return err
			}
		}

	}

	if len(res) > 0 {
		return errors.CompositeValidationError(res...)
	}
	return nil
}