get_list_of_friends_parameters.go

// Copyright (c) 2021 AccelByte Inc. All Rights Reserved.
// This is licensed software from AccelByte Inc, for limitations
// and restrictions contact your company contract manager.

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

package friends

// 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/AccelByte/accelbyte-go-sdk/services-api/pkg/utils"
	"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"
)

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

		timeout: cr.DefaultTimeout,
	}
}

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

		timeout: timeout,
	}
}

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

		Context: ctx,
	}
}

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

/*GetListOfFriendsParams contains all the parameters to send to the API endpoint
for the get list of friends operation typically these are written to a http.Request
*/
type GetListOfFriendsParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Limit
	  maximum number of data

	*/
	Limit *int64
	/*Namespace
	  namespace

	*/
	Namespace string
	/*Offset
	  numbers of row to skip within the result

	*/
	Offset *int64
	/*UserID
	  user ID

	*/
	UserID string

	timeout        time.Duration
	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
}

// WithTimeout adds the timeout to the get list of friends params
func (o *GetListOfFriendsParams) WithTimeout(timeout time.Duration) *GetListOfFriendsParams {
	o.SetTimeout(timeout)
	return o
}

// SetTimeout adds the timeout to the get list of friends params
func (o *GetListOfFriendsParams) SetTimeout(timeout time.Duration) {
	o.timeout = timeout
}

// WithContext adds the context to the get list of friends params
func (o *GetListOfFriendsParams) WithContext(ctx context.Context) *GetListOfFriendsParams {
	o.SetContext(ctx)
	return o
}

// SetContext adds the context to the get list of friends params
func (o *GetListOfFriendsParams) SetContext(ctx context.Context) {
	o.Context = ctx
}

// SetAuthInfoWriter adds the authInfoWriter to the get list of friends params
func (o *GetListOfFriendsParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter) {
	o.AuthInfoWriter = authInfoWriter
}

// WithHTTPClient adds the HTTPClient to the get list of friends params
func (o *GetListOfFriendsParams) WithHTTPClient(client *http.Client) *GetListOfFriendsParams {
	o.SetHTTPClient(client)
	return o
}

// SetHTTPClient adds the HTTPClient to the get list of friends params
func (o *GetListOfFriendsParams) SetHTTPClient(client *http.Client) {
	o.HTTPClient = client
}

// SetHTTPClient adds the HTTPClient Transport to the get list of friends params
func (o *GetListOfFriendsParams) SetHTTPClientTransport(roundTripper http.RoundTripper) {
	if o.HTTPClient != nil {
		o.HTTPClient.Transport = roundTripper
	} else {
		o.HTTPClient = &http.Client{Transport: roundTripper}
	}
}

// WithLimit adds the limit to the get list of friends params
func (o *GetListOfFriendsParams) WithLimit(limit *int64) *GetListOfFriendsParams {
	o.SetLimit(limit)
	return o
}

// SetLimit adds the limit to the get list of friends params
func (o *GetListOfFriendsParams) SetLimit(limit *int64) {
	o.Limit = limit
}

// WithNamespace adds the namespace to the get list of friends params
func (o *GetListOfFriendsParams) WithNamespace(namespace string) *GetListOfFriendsParams {
	o.SetNamespace(namespace)
	return o
}

// SetNamespace adds the namespace to the get list of friends params
func (o *GetListOfFriendsParams) SetNamespace(namespace string) {
	o.Namespace = namespace
}

// WithOffset adds the offset to the get list of friends params
func (o *GetListOfFriendsParams) WithOffset(offset *int64) *GetListOfFriendsParams {
	o.SetOffset(offset)
	return o
}

// SetOffset adds the offset to the get list of friends params
func (o *GetListOfFriendsParams) SetOffset(offset *int64) {
	o.Offset = offset
}

// WithUserID adds the userID to the get list of friends params
func (o *GetListOfFriendsParams) WithUserID(userID string) *GetListOfFriendsParams {
	o.SetUserID(userID)
	return o
}

// SetUserID adds the userId to the get list of friends params
func (o *GetListOfFriendsParams) SetUserID(userID string) {
	o.UserID = userID
}

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

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

	if o.Limit != nil {

		// query param limit
		var qrLimit int64
		if o.Limit != nil {
			qrLimit = *o.Limit
		}
		qLimit := swag.FormatInt64(qrLimit)
		if qLimit != "" {
			if err := r.SetQueryParam("limit", qLimit); err != nil {
				return err
			}
		}

	}

	// path param namespace
	if err := r.SetPathParam("namespace", o.Namespace); err != nil {
		return err
	}

	if o.Offset != nil {

		// query param offset
		var qrOffset int64
		if o.Offset != nil {
			qrOffset = *o.Offset
		}
		qOffset := swag.FormatInt64(qrOffset)
		if qOffset != "" {
			if err := r.SetQueryParam("offset", qOffset); err != nil {
				return err
			}
		}

	}

	// path param userId
	if err := r.SetPathParam("userId", o.UserID); err != nil {
		return err
	}

	// setting the default header value
	if err := r.SetHeaderParam("User-Agent", utils.UserAgentGen()); err != nil {
		return err
	}

	if err := r.SetHeaderParam("X-Amzn-Trace-Id", utils.AmazonTraceIDGen()); err != nil {
		return err
	}

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

	return nil
}