insights

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 13, 2021 License: MIT Imports: 22 Imported by: 8

README

Go API client for insights

BitBucket Server Code Insights API

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./insights"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost/rest

Class Method HTTP request Description
InsightsApi CreateAnnotations Post /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey}/annotations Add annotations to the given report.
InsightsApi DeleteAnnotations Delete /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey}/annotations Delete annotations
InsightsApi DeleteReport Delete /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey} Delete a report for the given commit. Also deletes any annotations associated with this report.
InsightsApi GetAnnotations Get /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/annotations Retrieve the specified commit's annotations.
InsightsApi GetReport Get /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey} Retrieve the specified report.
InsightsApi GetReportAnnotations Get /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey}/annotations Retrieve the specified report's annotations.
InsightsApi GetReports Get /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reposts Get reports list for specified commit
InsightsApi UpdateAnnotation Put /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey}/annotations/{externalId} Create an annotation with the given external ID, or replace it if it already exists.
InsightsApi UpdateReport Put /insights/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/reports/{reportKey} Create a new insight report, or replace the existing one.

Documentation For Models

Documentation For Authorization

basicAuth
  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)
bearerAuth
  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARERTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	InsightsApi *InsightsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the BitBucket Server Code Insights API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type Annotation 

type Annotation struct {
	// The path of the file on which this annotation should be placed. This is the path of the file relative to the git repository
	Path string `json:"path"`
	// The line number that the annotation should belong to. For file-level annotations, the line number should be 0
	Line int32 `json:"line"`
	// The message to display to users. The maximum length accepted is 2000 characters, however the user interface may truncate this value for display purposes. We recommend that the message is short and succinct, with further details available to the user if needed on the page linked to by the the annotation link.
	Message string `json:"message"`
	// The severity of the annotation
	Severity string `json:"severity"`
	// An http or https URL representing the location of the annotation in the external tool
	Link *string `json:"link,omitempty"`
	// The type of annotation posted
	Type *string `json:"type,omitempty"`
	// If the caller requires a link to get or modify this annotation, then an ID must be provided. It is not used or required by Bitbucket, but only by the annotation creator for updating or deleting this specific annotation.
	ExternalId *string `json:"externalId,omitempty"`
}

Annotation struct for Annotation

func NewAnnotation 

func NewAnnotation(path string, line int32, message string, severity string) *Annotation

NewAnnotation instantiates a new Annotation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAnnotationWithDefaults 

func NewAnnotationWithDefaults() *Annotation

NewAnnotationWithDefaults instantiates a new Annotation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Annotation) GetExternalId 

func (o *Annotation) GetExternalId() string

GetExternalId returns the ExternalId field value if set, zero value otherwise.

func (*Annotation) GetExternalIdOk 

func (o *Annotation) GetExternalIdOk() (*string, bool)

GetExternalIdOk returns a tuple with the ExternalId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Annotation) GetLine 

func (o *Annotation) GetLine() int32

GetLine returns the Line field value

func (*Annotation) GetLineOk 

func (o *Annotation) GetLineOk() (*int32, bool)

GetLineOk returns a tuple with the Line field value and a boolean to check if the value has been set. 

func (o *Annotation) GetLink() string

GetLink returns the Link field value if set, zero value otherwise.

func (*Annotation) GetLinkOk 

func (o *Annotation) GetLinkOk() (*string, bool)

GetLinkOk returns a tuple with the Link field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Annotation) GetMessage 

func (o *Annotation) GetMessage() string

GetMessage returns the Message field value

func (*Annotation) GetMessageOk 

func (o *Annotation) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Annotation) GetPath 

func (o *Annotation) GetPath() string

GetPath returns the Path field value

func (*Annotation) GetPathOk 

func (o *Annotation) GetPathOk() (*string, bool)

GetPathOk returns a tuple with the Path field value and a boolean to check if the value has been set.

func (*Annotation) GetSeverity 

func (o *Annotation) GetSeverity() string

GetSeverity returns the Severity field value

func (*Annotation) GetSeverityOk 

func (o *Annotation) GetSeverityOk() (*string, bool)

GetSeverityOk returns a tuple with the Severity field value and a boolean to check if the value has been set.

func (*Annotation) GetType 

func (o *Annotation) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*Annotation) GetTypeOk 

func (o *Annotation) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Annotation) HasExternalId 

func (o *Annotation) HasExternalId() bool

HasExternalId returns a boolean if a field has been set. 

func (o *Annotation) HasLink() bool

HasLink returns a boolean if a field has been set.

func (*Annotation) HasType 

func (o *Annotation) HasType() bool

HasType returns a boolean if a field has been set.

func (Annotation) MarshalJSON 

func (o Annotation) MarshalJSON() ([]byte, error)

func (*Annotation) SetExternalId 

func (o *Annotation) SetExternalId(v string)

SetExternalId gets a reference to the given string and assigns it to the ExternalId field.

func (*Annotation) SetLine 

func (o *Annotation) SetLine(v int32)

SetLine sets field value 

func (o *Annotation) SetLink(v string)

SetLink gets a reference to the given string and assigns it to the Link field.

func (*Annotation) SetMessage 

func (o *Annotation) SetMessage(v string)

SetMessage sets field value

func (*Annotation) SetPath 

func (o *Annotation) SetPath(v string)

SetPath sets field value

func (*Annotation) SetSeverity 

func (o *Annotation) SetSeverity(v string)

SetSeverity sets field value

func (*Annotation) SetType 

func (o *Annotation) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

type AnnotationsList 

type AnnotationsList struct {
	Annotations []Annotation `json:"annotations"`
}

AnnotationsList struct for AnnotationsList

func NewAnnotationsList 

func NewAnnotationsList(annotations []Annotation) *AnnotationsList

NewAnnotationsList instantiates a new AnnotationsList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAnnotationsListWithDefaults 

func NewAnnotationsListWithDefaults() *AnnotationsList

NewAnnotationsListWithDefaults instantiates a new AnnotationsList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*AnnotationsList) GetAnnotations 

func (o *AnnotationsList) GetAnnotations() []Annotation

GetAnnotations returns the Annotations field value

func (*AnnotationsList) GetAnnotationsOk 

func (o *AnnotationsList) GetAnnotationsOk() (*[]Annotation, bool)

GetAnnotationsOk returns a tuple with the Annotations field value and a boolean to check if the value has been set.

func (AnnotationsList) MarshalJSON 

func (o AnnotationsList) MarshalJSON() ([]byte, error)

func (*AnnotationsList) SetAnnotations 

func (o *AnnotationsList) SetAnnotations(v []Annotation)

SetAnnotations sets field value

type ApiCreateAnnotationsRequest 

type ApiCreateAnnotationsRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiCreateAnnotationsRequest) AnnotationsList 

func (r ApiCreateAnnotationsRequest) AnnotationsList(annotationsList AnnotationsList) ApiCreateAnnotationsRequest

func (ApiCreateAnnotationsRequest) Execute 

func (r ApiCreateAnnotationsRequest) Execute() (*_nethttp.Response, error)

type ApiDeleteAnnotationsRequest 

type ApiDeleteAnnotationsRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteAnnotationsRequest) Execute 

func (r ApiDeleteAnnotationsRequest) Execute() (*_nethttp.Response, error)

func (ApiDeleteAnnotationsRequest) ExternalId 

func (r ApiDeleteAnnotationsRequest) ExternalId(externalId string) ApiDeleteAnnotationsRequest

type ApiDeleteReportRequest 

type ApiDeleteReportRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiDeleteReportRequest) Execute 

func (r ApiDeleteReportRequest) Execute() (*_nethttp.Response, error)

type ApiGetAnnotationsRequest 

type ApiGetAnnotationsRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiGetAnnotationsRequest) Execute 

func (r ApiGetAnnotationsRequest) Execute() (AnnotationsList, *_nethttp.Response, error)

func (ApiGetAnnotationsRequest) ExternalId 

func (r ApiGetAnnotationsRequest) ExternalId(externalId string) ApiGetAnnotationsRequest

func (ApiGetAnnotationsRequest) Key 

func (r ApiGetAnnotationsRequest) Key(key string) ApiGetAnnotationsRequest

func (ApiGetAnnotationsRequest) Path 

func (r ApiGetAnnotationsRequest) Path(path string) ApiGetAnnotationsRequest

func (ApiGetAnnotationsRequest) Severity 

func (r ApiGetAnnotationsRequest) Severity(severity string) ApiGetAnnotationsRequest

func (ApiGetAnnotationsRequest) Type_ 

func (r ApiGetAnnotationsRequest) Type_(type_ string) ApiGetAnnotationsRequest

type ApiGetReportAnnotationsRequest 

type ApiGetReportAnnotationsRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiGetReportAnnotationsRequest) Execute 

func (r ApiGetReportAnnotationsRequest) Execute() (AnnotationsList, *_nethttp.Response, error)

type ApiGetReportRequest 

type ApiGetReportRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiGetReportRequest) Execute 

func (r ApiGetReportRequest) Execute() (Report, *_nethttp.Response, error)

type ApiGetReportsRequest 

type ApiGetReportsRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiGetReportsRequest) Execute 

func (r ApiGetReportsRequest) Execute() (ReportsListResponse, *_nethttp.Response, error)

func (ApiGetReportsRequest) Limit 

func (r ApiGetReportsRequest) Limit(limit int32) ApiGetReportsRequest

func (ApiGetReportsRequest) Start 

func (r ApiGetReportsRequest) Start(start int32) ApiGetReportsRequest

type ApiUpdateAnnotationRequest 

type ApiUpdateAnnotationRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateAnnotationRequest) Annotation 

func (r ApiUpdateAnnotationRequest) Annotation(annotation Annotation) ApiUpdateAnnotationRequest

func (ApiUpdateAnnotationRequest) Execute 

func (r ApiUpdateAnnotationRequest) Execute() (*_nethttp.Response, error)

type ApiUpdateReportRequest 

type ApiUpdateReportRequest struct {
	ApiService *InsightsApiService
	// contains filtered or unexported fields
}

func (ApiUpdateReportRequest) Execute 

func (r ApiUpdateReportRequest) Execute() (Report, *_nethttp.Response, error)

func (ApiUpdateReportRequest) Report 

func (r ApiUpdateReportRequest) Report(report Report) ApiUpdateReportRequest

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type Error 

type Error struct {
	// The context attribute indicates which parameter or request entity attribute failed validation. Note that the context may be null.
	Context NullableString `json:"context"`
	// Error description
	Message       string         `json:"message"`
	ExceptionName NullableString `json:"exceptionName"`
}

Error struct for Error

func NewError 

func NewError(context NullableString, message string, exceptionName NullableString) *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetContext 

func (o *Error) GetContext() string

GetContext returns the Context field value If the value is explicit nil, the zero value for string will be returned

func (*Error) GetContextOk 

func (o *Error) GetContextOk() (*string, bool)

GetContextOk returns a tuple with the Context field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Error) GetExceptionName 

func (o *Error) GetExceptionName() string

GetExceptionName returns the ExceptionName field value If the value is explicit nil, the zero value for string will be returned

func (*Error) GetExceptionNameOk 

func (o *Error) GetExceptionNameOk() (*string, bool)

GetExceptionNameOk returns a tuple with the ExceptionName field value and a boolean to check if the value has been set. NOTE: If the value is an explicit nil, `nil, true` will be returned

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (Error) MarshalJSON 

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetContext 

func (o *Error) SetContext(v string)

SetContext sets field value

func (*Error) SetExceptionName 

func (o *Error) SetExceptionName(v string)

SetExceptionName sets field value

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

type ErrorResponse 

type ErrorResponse struct {
	Errors []Error `json:"errors"`
}

ErrorResponse struct for ErrorResponse

func NewErrorResponse 

func NewErrorResponse(errors []Error) *ErrorResponse

NewErrorResponse instantiates a new ErrorResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorResponseWithDefaults 

func NewErrorResponseWithDefaults() *ErrorResponse

NewErrorResponseWithDefaults instantiates a new ErrorResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorResponse) GetErrors 

func (o *ErrorResponse) GetErrors() []Error

GetErrors returns the Errors field value

func (*ErrorResponse) GetErrorsOk 

func (o *ErrorResponse) GetErrorsOk() (*[]Error, bool)

GetErrorsOk returns a tuple with the Errors field value and a boolean to check if the value has been set.

func (ErrorResponse) MarshalJSON 

func (o ErrorResponse) MarshalJSON() ([]byte, error)

func (*ErrorResponse) SetErrors 

func (o *ErrorResponse) SetErrors(v []Error)

SetErrors sets field value

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type InsightsApiService 

type InsightsApiService service

InsightsApiService InsightsApi service

func (*InsightsApiService) CreateAnnotations 

func (a *InsightsApiService) CreateAnnotations(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string) ApiCreateAnnotationsRequest
  • CreateAnnotations Add annotations to the given report.
  • The request should be a JSON object mapping the string "annotations" to an array of maps containing the

annotation data, as described below. See also the example request. A few things to note:

Annotations are an extension of a report, so a report must first exist in order to post annotations. Annotations are posted separately from the report, and can be posted in bulk using this endpoint.

Only the annotations that are on lines changed in the unified diff will be displayed. This means it is likely not all annotations posted will be displayed on the pull request It also means that if the user is viewing a side-by-side diff, commit diff or iterative review diff they will not be able to view the annotations.

A report cannot have more than 1000 annotations by default, however this property is congurable at an instance level. If the request would result in more than the maximum number of annotations being stored then the entire request is rejected and no new annotations are stored.

There is no de-duplication of annotations on Bitbucket so be sure that reruns of builds will first delete the report and annotations before creating them.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectKey The project key
  • @param repositorySlug The repository slug
  • @param commitId The commit ID. This must be a full 40 character commit hash
  • @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS.
  • @return ApiCreateAnnotationsRequest

func (*InsightsApiService) CreateAnnotationsExecute 

func (a *InsightsApiService) CreateAnnotationsExecute(r ApiCreateAnnotationsRequest) (*_nethttp.Response, error)

* Execute executes the request

func (*InsightsApiService) DeleteAnnotations 

func (a *InsightsApiService) DeleteAnnotations(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string) ApiDeleteAnnotationsRequest
  • DeleteAnnotations Delete annotations
  • Delete annotations for a given report that match the given external IDs, or all annotations if no

external IDs are provided.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectKey The project key
  • @param repositorySlug The repository slug
  • @param commitId The commit ID. This must be a full 40 character commit hash
  • @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS.
  • @return ApiDeleteAnnotationsRequest

func (*InsightsApiService) DeleteAnnotationsExecute 

func (a *InsightsApiService) DeleteAnnotationsExecute(r ApiDeleteAnnotationsRequest) (*_nethttp.Response, error)

* Execute executes the request

func (*InsightsApiService) DeleteReport 

func (a *InsightsApiService) DeleteReport(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string) ApiDeleteReportRequest

* DeleteReport Delete a report for the given commit. Also deletes any annotations associated with this report. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param projectKey The project key * @param repositorySlug The repository slug * @param commitId The commit ID. This must be a full 40 character commit hash * @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS. * @return ApiDeleteReportRequest

func (*InsightsApiService) DeleteReportExecute 

func (a *InsightsApiService) DeleteReportExecute(r ApiDeleteReportRequest) (*_nethttp.Response, error)

* Execute executes the request

func (*InsightsApiService) GetAnnotations 

func (a *InsightsApiService) GetAnnotations(ctx _context.Context, projectKey string, repositorySlug string, commitId string) ApiGetAnnotationsRequest

* GetAnnotations Retrieve the specified commit's annotations. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param projectKey The project key * @param repositorySlug The repository slug * @param commitId The commit ID. This must be a full 40 character commit hash * @return ApiGetAnnotationsRequest

func (*InsightsApiService) GetAnnotationsExecute 

func (a *InsightsApiService) GetAnnotationsExecute(r ApiGetAnnotationsRequest) (AnnotationsList, *_nethttp.Response, error)

* Execute executes the request * @return AnnotationsList

func (*InsightsApiService) GetReport 

func (a *InsightsApiService) GetReport(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string) ApiGetReportRequest

* GetReport Retrieve the specified report. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param projectKey The project key * @param repositorySlug The repository slug * @param commitId The commit ID. This must be a full 40 character commit hash * @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS. * @return ApiGetReportRequest

func (*InsightsApiService) GetReportAnnotations 

func (a *InsightsApiService) GetReportAnnotations(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string) ApiGetReportAnnotationsRequest

* GetReportAnnotations Retrieve the specified report's annotations. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param projectKey The project key * @param repositorySlug The repository slug * @param commitId The commit ID. This must be a full 40 character commit hash * @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS. * @return ApiGetReportAnnotationsRequest

func (*InsightsApiService) GetReportAnnotationsExecute 

func (a *InsightsApiService) GetReportAnnotationsExecute(r ApiGetReportAnnotationsRequest) (AnnotationsList, *_nethttp.Response, error)

* Execute executes the request * @return AnnotationsList

func (*InsightsApiService) GetReportExecute 

func (a *InsightsApiService) GetReportExecute(r ApiGetReportRequest) (Report, *_nethttp.Response, error)

* Execute executes the request * @return Report

func (*InsightsApiService) GetReports 

func (a *InsightsApiService) GetReports(ctx _context.Context, projectKey string, repositorySlug string, commitId string) ApiGetReportsRequest

* GetReports Get reports list for specified commit * Retrieve all reports for the given commit. * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param projectKey The project key * @param repositorySlug The repository slug * @param commitId The commit ID. This must be a full 40 character commit hash * @return ApiGetReportsRequest

func (*InsightsApiService) GetReportsExecute 

func (a *InsightsApiService) GetReportsExecute(r ApiGetReportsRequest) (ReportsListResponse, *_nethttp.Response, error)

* Execute executes the request * @return ReportsListResponse

func (*InsightsApiService) UpdateAnnotation 

func (a *InsightsApiService) UpdateAnnotation(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string, externalId string) ApiUpdateAnnotationRequest
  • UpdateAnnotation Create an annotation with the given external ID, or replace it if it already exists.
  • A request to replace an existing annotation will be rejected if the authenticated user was not the

creator of the specified report.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectKey The project key
  • @param repositorySlug The repository slug
  • @param commitId The commit ID. This must be a full 40 character commit hash
  • @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS.
  • @param externalId The external ID of the annotation that is to be updated or created
  • @return ApiUpdateAnnotationRequest

func (*InsightsApiService) UpdateAnnotationExecute 

func (a *InsightsApiService) UpdateAnnotationExecute(r ApiUpdateAnnotationRequest) (*_nethttp.Response, error)

* Execute executes the request

func (*InsightsApiService) UpdateReport 

func (a *InsightsApiService) UpdateReport(ctx _context.Context, projectKey string, repositorySlug string, commitId string, reportKey string) ApiUpdateReportRequest
  • UpdateReport Create a new insight report, or replace the existing one.
  • Create a new insight report, or replace the existing one if a report already exists for the given repository,

commit, and report key. A request to replace an existing report will be rejected if the authenticated user was not the creator of the specified report. The report key should be a unique string chosen by the reporter and should be unique enough not to potentially clash with report keys from other reporters. We recommend using reverse DNS namespacing or a similar standard to ensure that collision is avoided.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectKey The project key
  • @param repositorySlug The repository slug
  • @param commitId The commit ID. This must be a full 40 character commit hash
  • @param reportKey A unique string representing the report as chosen by the reporter. This should be unique enough to not clash with other report's keys. To do this, we recommend namespacing the key using reverse DNS.
  • @return ApiUpdateReportRequest

func (*InsightsApiService) UpdateReportExecute 

func (a *InsightsApiService) UpdateReportExecute(r ApiUpdateReportRequest) (Report, *_nethttp.Response, error)

* Execute executes the request * @return Report

type NullableAnnotation 

type NullableAnnotation struct {
	// contains filtered or unexported fields
}

func NewNullableAnnotation 

func NewNullableAnnotation(val *Annotation) *NullableAnnotation

func (NullableAnnotation) Get 

func (v NullableAnnotation) Get() *Annotation

func (NullableAnnotation) IsSet 

func (v NullableAnnotation) IsSet() bool

func (NullableAnnotation) MarshalJSON 

func (v NullableAnnotation) MarshalJSON() ([]byte, error)

func (*NullableAnnotation) Set 

func (v *NullableAnnotation) Set(val *Annotation)

func (*NullableAnnotation) UnmarshalJSON 

func (v *NullableAnnotation) UnmarshalJSON(src []byte) error

func (*NullableAnnotation) Unset 

func (v *NullableAnnotation) Unset()

type NullableAnnotationsList 

type NullableAnnotationsList struct {
	// contains filtered or unexported fields
}

func NewNullableAnnotationsList 

func NewNullableAnnotationsList(val *AnnotationsList) *NullableAnnotationsList

func (NullableAnnotationsList) Get 

func (v NullableAnnotationsList) Get() *AnnotationsList

func (NullableAnnotationsList) IsSet 

func (v NullableAnnotationsList) IsSet() bool

func (NullableAnnotationsList) MarshalJSON 

func (v NullableAnnotationsList) MarshalJSON() ([]byte, error)

func (*NullableAnnotationsList) Set 

func (v *NullableAnnotationsList) Set(val *AnnotationsList)

func (*NullableAnnotationsList) UnmarshalJSON 

func (v *NullableAnnotationsList) UnmarshalJSON(src []byte) error

func (*NullableAnnotationsList) Unset 

func (v *NullableAnnotationsList) Unset()

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableError 

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrorResponse 

type NullableErrorResponse struct {
	// contains filtered or unexported fields
}

func NewNullableErrorResponse 

func NewNullableErrorResponse(val *ErrorResponse) *NullableErrorResponse

func (NullableErrorResponse) Get 

func (v NullableErrorResponse) Get() *ErrorResponse

func (NullableErrorResponse) IsSet 

func (v NullableErrorResponse) IsSet() bool

func (NullableErrorResponse) MarshalJSON 

func (v NullableErrorResponse) MarshalJSON() ([]byte, error)

func (*NullableErrorResponse) Set 

func (v *NullableErrorResponse) Set(val *ErrorResponse)

func (*NullableErrorResponse) UnmarshalJSON 

func (v *NullableErrorResponse) UnmarshalJSON(src []byte) error

func (*NullableErrorResponse) Unset 

func (v *NullableErrorResponse) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableReport 

type NullableReport struct {
	// contains filtered or unexported fields
}

func NewNullableReport 

func NewNullableReport(val *Report) *NullableReport

func (NullableReport) Get 

func (v NullableReport) Get() *Report

func (NullableReport) IsSet 

func (v NullableReport) IsSet() bool

func (NullableReport) MarshalJSON 

func (v NullableReport) MarshalJSON() ([]byte, error)

func (*NullableReport) Set 

func (v *NullableReport) Set(val *Report)

func (*NullableReport) UnmarshalJSON 

func (v *NullableReport) UnmarshalJSON(src []byte) error

func (*NullableReport) Unset 

func (v *NullableReport) Unset()

type NullableReportsListResponse 

type NullableReportsListResponse struct {
	// contains filtered or unexported fields
}

func NewNullableReportsListResponse 

func NewNullableReportsListResponse(val *ReportsListResponse) *NullableReportsListResponse

func (NullableReportsListResponse) Get 

func (v NullableReportsListResponse) Get() *ReportsListResponse

func (NullableReportsListResponse) IsSet 

func (v NullableReportsListResponse) IsSet() bool

func (NullableReportsListResponse) MarshalJSON 

func (v NullableReportsListResponse) MarshalJSON() ([]byte, error)

func (*NullableReportsListResponse) Set 

func (v *NullableReportsListResponse) Set(val *ReportsListResponse)

func (*NullableReportsListResponse) UnmarshalJSON 

func (v *NullableReportsListResponse) UnmarshalJSON(src []byte) error

func (*NullableReportsListResponse) Unset 

func (v *NullableReportsListResponse) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type Report 

type Report struct {
	// A short string representing the name of the report
	Title string `json:"title"`
	// A string to describe the purpose of the report. This string may contain escaped newlines and if it does it will display the content accordingly.
	Details *string `json:"details,omitempty"`
	// Indicates whether the report is in a passed or failed state
	Result *string `json:"result,omitempty"`
	// A string to describe the tool or company who created the report
	Reporter *string `json:"reporter,omitempty"`
	// A URL linking to the results of the report in an external tool. Must be a valid http or https URL
	Link *string `json:"link,omitempty"`
	// A URL to the report logo. If none is provided, the default insights logo will be used. Must be a valid http or https URL
	LogoUrl *string `json:"logoUrl,omitempty"`
}

Report struct for Report

func NewReport 

func NewReport(title string) *Report

NewReport instantiates a new Report object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReportWithDefaults 

func NewReportWithDefaults() *Report

NewReportWithDefaults instantiates a new Report object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Report) GetDetails 

func (o *Report) GetDetails() string

GetDetails returns the Details field value if set, zero value otherwise.

func (*Report) GetDetailsOk 

func (o *Report) GetDetailsOk() (*string, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set. 

func (o *Report) GetLink() string

GetLink returns the Link field value if set, zero value otherwise.

func (*Report) GetLinkOk 

func (o *Report) GetLinkOk() (*string, bool)

GetLinkOk returns a tuple with the Link field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Report) GetLogoUrl 

func (o *Report) GetLogoUrl() string

GetLogoUrl returns the LogoUrl field value if set, zero value otherwise.

func (*Report) GetLogoUrlOk 

func (o *Report) GetLogoUrlOk() (*string, bool)

GetLogoUrlOk returns a tuple with the LogoUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Report) GetReporter 

func (o *Report) GetReporter() string

GetReporter returns the Reporter field value if set, zero value otherwise.

func (*Report) GetReporterOk 

func (o *Report) GetReporterOk() (*string, bool)

GetReporterOk returns a tuple with the Reporter field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Report) GetResult 

func (o *Report) GetResult() string

GetResult returns the Result field value if set, zero value otherwise.

func (*Report) GetResultOk 

func (o *Report) GetResultOk() (*string, bool)

GetResultOk returns a tuple with the Result field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Report) GetTitle 

func (o *Report) GetTitle() string

GetTitle returns the Title field value

func (*Report) GetTitleOk 

func (o *Report) GetTitleOk() (*string, bool)

GetTitleOk returns a tuple with the Title field value and a boolean to check if the value has been set.

func (*Report) HasDetails 

func (o *Report) HasDetails() bool

HasDetails returns a boolean if a field has been set. 

func (o *Report) HasLink() bool

HasLink returns a boolean if a field has been set.

func (*Report) HasLogoUrl 

func (o *Report) HasLogoUrl() bool

HasLogoUrl returns a boolean if a field has been set.

func (*Report) HasReporter 

func (o *Report) HasReporter() bool

HasReporter returns a boolean if a field has been set.

func (*Report) HasResult 

func (o *Report) HasResult() bool

HasResult returns a boolean if a field has been set.

func (Report) MarshalJSON 

func (o Report) MarshalJSON() ([]byte, error)

func (*Report) SetDetails 

func (o *Report) SetDetails(v string)

SetDetails gets a reference to the given string and assigns it to the Details field. 

func (o *Report) SetLink(v string)

SetLink gets a reference to the given string and assigns it to the Link field.

func (*Report) SetLogoUrl 

func (o *Report) SetLogoUrl(v string)

SetLogoUrl gets a reference to the given string and assigns it to the LogoUrl field.

func (*Report) SetReporter 

func (o *Report) SetReporter(v string)

SetReporter gets a reference to the given string and assigns it to the Reporter field.

func (*Report) SetResult 

func (o *Report) SetResult(v string)

SetResult gets a reference to the given string and assigns it to the Result field.

func (*Report) SetTitle 

func (o *Report) SetTitle(v string)

SetTitle sets field value

type ReportsListResponse 

type ReportsListResponse struct {
	Size          int32    `json:"size"`
	Limit         *int32   `json:"limit,omitempty"`
	Start         int32    `json:"start"`
	IsLastPage    bool     `json:"isLastPage"`
	NextPageStart *int32   `json:"nextPageStart,omitempty"`
	Values        []Report `json:"values"`
}

ReportsListResponse struct for ReportsListResponse

func NewReportsListResponse 

func NewReportsListResponse(size int32, start int32, isLastPage bool, values []Report) *ReportsListResponse

NewReportsListResponse instantiates a new ReportsListResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReportsListResponseWithDefaults 

func NewReportsListResponseWithDefaults() *ReportsListResponse

NewReportsListResponseWithDefaults instantiates a new ReportsListResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ReportsListResponse) GetIsLastPage 

func (o *ReportsListResponse) GetIsLastPage() bool

GetIsLastPage returns the IsLastPage field value

func (*ReportsListResponse) GetIsLastPageOk 

func (o *ReportsListResponse) GetIsLastPageOk() (*bool, bool)

GetIsLastPageOk returns a tuple with the IsLastPage field value and a boolean to check if the value has been set.

func (*ReportsListResponse) GetLimit 

func (o *ReportsListResponse) GetLimit() int32

GetLimit returns the Limit field value if set, zero value otherwise.

func (*ReportsListResponse) GetLimitOk 

func (o *ReportsListResponse) GetLimitOk() (*int32, bool)

GetLimitOk returns a tuple with the Limit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReportsListResponse) GetNextPageStart 

func (o *ReportsListResponse) GetNextPageStart() int32

GetNextPageStart returns the NextPageStart field value if set, zero value otherwise.

func (*ReportsListResponse) GetNextPageStartOk 

func (o *ReportsListResponse) GetNextPageStartOk() (*int32, bool)

GetNextPageStartOk returns a tuple with the NextPageStart field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReportsListResponse) GetSize 

func (o *ReportsListResponse) GetSize() int32

GetSize returns the Size field value

func (*ReportsListResponse) GetSizeOk 

func (o *ReportsListResponse) GetSizeOk() (*int32, bool)

GetSizeOk returns a tuple with the Size field value and a boolean to check if the value has been set.

func (*ReportsListResponse) GetStart 

func (o *ReportsListResponse) GetStart() int32

GetStart returns the Start field value

func (*ReportsListResponse) GetStartOk 

func (o *ReportsListResponse) GetStartOk() (*int32, bool)

GetStartOk returns a tuple with the Start field value and a boolean to check if the value has been set.

func (*ReportsListResponse) GetValues 

func (o *ReportsListResponse) GetValues() []Report

GetValues returns the Values field value

func (*ReportsListResponse) GetValuesOk 

func (o *ReportsListResponse) GetValuesOk() (*[]Report, bool)

GetValuesOk returns a tuple with the Values field value and a boolean to check if the value has been set.

func (*ReportsListResponse) HasLimit 

func (o *ReportsListResponse) HasLimit() bool

HasLimit returns a boolean if a field has been set.

func (*ReportsListResponse) HasNextPageStart 

func (o *ReportsListResponse) HasNextPageStart() bool

HasNextPageStart returns a boolean if a field has been set.

func (ReportsListResponse) MarshalJSON 

func (o ReportsListResponse) MarshalJSON() ([]byte, error)

func (*ReportsListResponse) SetIsLastPage 

func (o *ReportsListResponse) SetIsLastPage(v bool)

SetIsLastPage sets field value

func (*ReportsListResponse) SetLimit 

func (o *ReportsListResponse) SetLimit(v int32)

SetLimit gets a reference to the given int32 and assigns it to the Limit field.

func (*ReportsListResponse) SetNextPageStart 

func (o *ReportsListResponse) SetNextPageStart(v int32)

SetNextPageStart gets a reference to the given int32 and assigns it to the NextPageStart field.

func (*ReportsListResponse) SetSize 

func (o *ReportsListResponse) SetSize(v int32)

SetSize sets field value

func (*ReportsListResponse) SetStart 

func (o *ReportsListResponse) SetStart(v int32)

SetStart sets field value

func (*ReportsListResponse) SetValues 

func (o *ReportsListResponse) SetValues(v []Report)

SetValues sets field value

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.