summary_dashboard_client.go

/*
Copyright (c) 2020 Red Hat, Inc.

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.
*/

// IMPORTANT: This file has been generated automatically, refrain from modifying it manually as all
// your changes will be lost when the file is generated again.

package v1 // github.com/openshift-online/ocm-sdk-go/accountsmgmt/v1

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

	"github.com/openshift-online/ocm-sdk-go/errors"
	"github.com/openshift-online/ocm-sdk-go/helpers"
)

// SummaryDashboardClient is the client of the 'summary_dashboard' resource.
//
// Manages a specific organization's summary dashboard.
type SummaryDashboardClient struct {
	transport http.RoundTripper
	path      string
	metric    string
}

// NewSummaryDashboardClient creates a new client for the 'summary_dashboard'
// resource using the given transport to send the requests and receive the
// responses.
func NewSummaryDashboardClient(transport http.RoundTripper, path string, metric string) *SummaryDashboardClient {
	return &SummaryDashboardClient{
		transport: transport,
		path:      path,
		metric:    metric,
	}
}

// Get creates a request for the 'get' method.
//
// Retrieves the details of the organization's summary dashboard.
func (c *SummaryDashboardClient) Get() *SummaryDashboardGetRequest {
	return &SummaryDashboardGetRequest{
		transport: c.transport,
		path:      c.path,
		metric:    c.metric,
	}
}

// SummaryDashboardPollRequest is the request for the Poll method.
type SummaryDashboardPollRequest struct {
	request    *SummaryDashboardGetRequest
	interval   time.Duration
	statuses   []int
	predicates []func(interface{}) bool
}

// Parameter adds a query parameter to all the requests that will be used to retrieve the object.
func (r *SummaryDashboardPollRequest) Parameter(name string, value interface{}) *SummaryDashboardPollRequest {
	r.request.Parameter(name, value)
	return r
}

// Header adds a request header to all the requests that will be used to retrieve the object.
func (r *SummaryDashboardPollRequest) Header(name string, value interface{}) *SummaryDashboardPollRequest {
	r.request.Header(name, value)
	return r
}

// Interval sets the polling interval. This parameter is mandatory and must be greater than zero.
func (r *SummaryDashboardPollRequest) Interval(value time.Duration) *SummaryDashboardPollRequest {
	r.interval = value
	return r
}

// Status set the expected status of the response. Multiple values can be set calling this method
// multiple times. The response will be considered successful if the status is any of those values.
func (r *SummaryDashboardPollRequest) Status(value int) *SummaryDashboardPollRequest {
	r.statuses = append(r.statuses, value)
	return r
}

// Predicate adds a predicate that the response should satisfy be considered successful. Multiple
// predicates can be set calling this method multiple times. The response will be considered successful
// if all the predicates are satisfied.
func (r *SummaryDashboardPollRequest) Predicate(value func(*SummaryDashboardGetResponse) bool) *SummaryDashboardPollRequest {
	r.predicates = append(r.predicates, func(response interface{}) bool {
		return value(response.(*SummaryDashboardGetResponse))
	})
	return r
}

// StartContext starts the polling loop. Responses will be considered successful if the status is one of
// the values specified with the Status method and if all the predicates specified with the Predicate
// method return nil.
//
// The context must have a timeout or deadline, otherwise this method will immediately return an error.
func (r *SummaryDashboardPollRequest) StartContext(ctx context.Context) (response *SummaryDashboardPollResponse, err error) {
	result, err := helpers.PollContext(ctx, r.interval, r.statuses, r.predicates, r.task)
	if result != nil {
		response = &SummaryDashboardPollResponse{
			response: result.(*SummaryDashboardGetResponse),
		}
	}
	return
}

// task adapts the types of the request/response types so that they can be used with the generic
// polling function from the helpers package.
func (r *SummaryDashboardPollRequest) task(ctx context.Context) (status int, result interface{}, err error) {
	response, err := r.request.SendContext(ctx)
	if response != nil {
		status = response.Status()
		result = response
	}
	return
}

// SummaryDashboardPollResponse is the response for the Poll method.
type SummaryDashboardPollResponse struct {
	response *SummaryDashboardGetResponse
}

// Status returns the response status code.
func (r *SummaryDashboardPollResponse) Status() int {
	if r == nil {
		return 0
	}
	return r.response.Status()
}

// Header returns header of the response.
func (r *SummaryDashboardPollResponse) Header() http.Header {
	if r == nil {
		return nil
	}
	return r.response.Header()
}

// Error returns the response error.
func (r *SummaryDashboardPollResponse) Error() *errors.Error {
	if r == nil {
		return nil
	}
	return r.response.Error()
}

// Body returns the value of the 'body' parameter.
//
//
func (r *SummaryDashboardPollResponse) Body() *SummaryDashboard {
	return r.response.Body()
}

// GetBody returns the value of the 'body' parameter and
// a flag indicating if the parameter has a value.
//
//
func (r *SummaryDashboardPollResponse) GetBody() (value *SummaryDashboard, ok bool) {
	return r.response.GetBody()
}

// Poll creates a request to repeatedly retrieve the object till the response has one of a given set
// of states and satisfies a set of predicates.
func (c *SummaryDashboardClient) Poll() *SummaryDashboardPollRequest {
	return &SummaryDashboardPollRequest{
		request: c.Get(),
	}
}

// SummaryDashboardGetRequest is the request for the 'get' method.
type SummaryDashboardGetRequest struct {
	transport http.RoundTripper
	path      string
	metric    string
	query     url.Values
	header    http.Header
}

// Parameter adds a query parameter.
func (r *SummaryDashboardGetRequest) Parameter(name string, value interface{}) *SummaryDashboardGetRequest {
	helpers.AddValue(&r.query, name, value)
	return r
}

// Header adds a request header.
func (r *SummaryDashboardGetRequest) Header(name string, value interface{}) *SummaryDashboardGetRequest {
	helpers.AddHeader(&r.header, name, value)
	return r
}

// Send sends this request, waits for the response, and returns it.
//
// This is a potentially lengthy operation, as it requires network communication.
// Consider using a context and the SendContext method.
func (r *SummaryDashboardGetRequest) Send() (result *SummaryDashboardGetResponse, err error) {
	return r.SendContext(context.Background())
}

// SendContext sends this request, waits for the response, and returns it.
func (r *SummaryDashboardGetRequest) SendContext(ctx context.Context) (result *SummaryDashboardGetResponse, err error) {
	query := helpers.CopyQuery(r.query)
	header := helpers.SetHeader(r.header, r.metric)
	uri := &url.URL{
		Path:     r.path,
		RawQuery: query.Encode(),
	}
	request := &http.Request{
		Method: "GET",
		URL:    uri,
		Header: header,
	}
	if ctx != nil {
		request = request.WithContext(ctx)
	}
	response, err := r.transport.RoundTrip(request)
	if err != nil {
		return
	}
	defer response.Body.Close()
	result = &SummaryDashboardGetResponse{}
	result.status = response.StatusCode
	result.header = response.Header
	if result.status >= 400 {
		result.err, err = errors.UnmarshalError(response.Body)
		if err != nil {
			return
		}
		err = result.err
		return
	}
	err = readSummaryDashboardGetResponse(result, response.Body)
	if err != nil {
		return
	}
	return
}

// SummaryDashboardGetResponse is the response for the 'get' method.
type SummaryDashboardGetResponse struct {
	status int
	header http.Header
	err    *errors.Error
	body   *SummaryDashboard
}

// Status returns the response status code.
func (r *SummaryDashboardGetResponse) Status() int {
	if r == nil {
		return 0
	}
	return r.status
}

// Header returns header of the response.
func (r *SummaryDashboardGetResponse) Header() http.Header {
	if r == nil {
		return nil
	}
	return r.header
}

// Error returns the response error.
func (r *SummaryDashboardGetResponse) Error() *errors.Error {
	if r == nil {
		return nil
	}
	return r.err
}

// Body returns the value of the 'body' parameter.
//
//
func (r *SummaryDashboardGetResponse) Body() *SummaryDashboard {
	if r == nil {
		return nil
	}
	return r.body
}

// GetBody returns the value of the 'body' parameter and
// a flag indicating if the parameter has a value.
//
//
func (r *SummaryDashboardGetResponse) GetBody() (value *SummaryDashboard, ok bool) {
	ok = r != nil && r.body != nil
	if ok {
		value = r.body
	}
	return
}