organization_pipelines

package
v1.0.98 Latest Latest
Warning

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

 Go to latest Published: May 29, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAcceptApplicationJSON 

func WithAcceptApplicationJSON(r *runtime.ClientOperation)

WithAcceptApplicationJSON sets the Accept header to "application/json".

func WithAcceptApplicationVndCycloidIoV1JSON 

func WithAcceptApplicationVndCycloidIoV1JSON(r *runtime.ClientOperation)

WithAcceptApplicationVndCycloidIoV1JSON sets the Accept header to "application/vnd.cycloid.io.v1+json".

func WithContentTypeApplicationJSON 

func WithContentTypeApplicationJSON(r *runtime.ClientOperation)

WithContentTypeApplicationJSON sets the Content-Type header to "application/json".

func WithContentTypeApplicationVndCycloidIoV1JSON 

func WithContentTypeApplicationVndCycloidIoV1JSON(r *runtime.ClientOperation)

WithContentTypeApplicationVndCycloidIoV1JSON sets the Content-Type header to "application/vnd.cycloid.io.v1+json".

func WithContentTypeApplicationxWwwFormUrlencoded 

func WithContentTypeApplicationxWwwFormUrlencoded(r *runtime.ClientOperation)

WithContentTypeApplicationxWwwFormUrlencoded sets the Content-Type header to "application/x-www-form-urlencoded".

Types

type Client 

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

Client for organization pipelines API

func (*Client) GetPipelines 

func (a *Client) GetPipelines(params *GetPipelinesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetPipelinesOK, error)

GetPipelines Get all the pipelines that the authenticated user has access to.

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

func WithAccept 

func WithAccept(mime string) ClientOption

WithAccept allows the client to force the Accept header to negotiate a specific Producer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

func WithContentType 

func WithContentType(mime string) ClientOption

WithContentType allows the client to force the Content-Type header to negotiate a specific Consumer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService 

type ClientService interface {
	GetPipelines(params *GetPipelinesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetPipelinesOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new organization pipelines API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new organization pipelines API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new organization pipelines API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetPipelinesDefault 

type GetPipelinesDefault struct {

	/* The length of the response body in octets (8-bit bytes).

	   Format: uint64
	*/
	ContentLength uint64

	Payload *models.ErrorPayload
	// contains filtered or unexported fields
}

GetPipelinesDefault describes a response with status code -1, with default header values.

The response sent when an unexpected error happened, as known as an internal server error.

func NewGetPipelinesDefault 

func NewGetPipelinesDefault(code int) *GetPipelinesDefault

NewGetPipelinesDefault creates a GetPipelinesDefault with default headers values

func (*GetPipelinesDefault) Code 

func (o *GetPipelinesDefault) Code() int

Code gets the status code for the get pipelines default response

func (*GetPipelinesDefault) Error 

func (o *GetPipelinesDefault) Error() string

func (*GetPipelinesDefault) GetPayload 

func (o *GetPipelinesDefault) GetPayload() *models.ErrorPayload

func (*GetPipelinesDefault) IsClientError 

func (o *GetPipelinesDefault) IsClientError() bool

IsClientError returns true when this get pipelines default response has a 4xx status code

func (*GetPipelinesDefault) IsCode 

func (o *GetPipelinesDefault) IsCode(code int) bool

IsCode returns true when this get pipelines default response a status code equal to that given

func (*GetPipelinesDefault) IsRedirect 

func (o *GetPipelinesDefault) IsRedirect() bool

IsRedirect returns true when this get pipelines default response has a 3xx status code

func (*GetPipelinesDefault) IsServerError 

func (o *GetPipelinesDefault) IsServerError() bool

IsServerError returns true when this get pipelines default response has a 5xx status code

func (*GetPipelinesDefault) IsSuccess 

func (o *GetPipelinesDefault) IsSuccess() bool

IsSuccess returns true when this get pipelines default response has a 2xx status code

func (*GetPipelinesDefault) String 

func (o *GetPipelinesDefault) String() string

type GetPipelinesNotFound 

type GetPipelinesNotFound struct {

	/* The length of the response body in octets (8-bit bytes).

	   Format: uint64
	*/
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetPipelinesNotFound describes a response with status code 404, with default header values.

The response sent when any of the entities present in the path is not found.

func NewGetPipelinesNotFound 

func NewGetPipelinesNotFound() *GetPipelinesNotFound

NewGetPipelinesNotFound creates a GetPipelinesNotFound with default headers values

func (*GetPipelinesNotFound) Code 

func (o *GetPipelinesNotFound) Code() int

Code gets the status code for the get pipelines not found response

func (*GetPipelinesNotFound) Error 

func (o *GetPipelinesNotFound) Error() string

func (*GetPipelinesNotFound) GetPayload 

func (o *GetPipelinesNotFound) GetPayload() *models.ErrorPayload

func (*GetPipelinesNotFound) IsClientError 

func (o *GetPipelinesNotFound) IsClientError() bool

IsClientError returns true when this get pipelines not found response has a 4xx status code

func (*GetPipelinesNotFound) IsCode 

func (o *GetPipelinesNotFound) IsCode(code int) bool

IsCode returns true when this get pipelines not found response a status code equal to that given

func (*GetPipelinesNotFound) IsRedirect 

func (o *GetPipelinesNotFound) IsRedirect() bool

IsRedirect returns true when this get pipelines not found response has a 3xx status code

func (*GetPipelinesNotFound) IsServerError 

func (o *GetPipelinesNotFound) IsServerError() bool

IsServerError returns true when this get pipelines not found response has a 5xx status code

func (*GetPipelinesNotFound) IsSuccess 

func (o *GetPipelinesNotFound) IsSuccess() bool

IsSuccess returns true when this get pipelines not found response has a 2xx status code

func (*GetPipelinesNotFound) String 

func (o *GetPipelinesNotFound) String() string

type GetPipelinesOK 

type GetPipelinesOK struct {
	Payload *GetPipelinesOKBody
}

GetPipelinesOK describes a response with status code 200, with default header values.

List of all the pipelines which authenticated user has access to.

func NewGetPipelinesOK 

func NewGetPipelinesOK() *GetPipelinesOK

NewGetPipelinesOK creates a GetPipelinesOK with default headers values

func (*GetPipelinesOK) Code 

func (o *GetPipelinesOK) Code() int

Code gets the status code for the get pipelines o k response

func (*GetPipelinesOK) Error 

func (o *GetPipelinesOK) Error() string

func (*GetPipelinesOK) GetPayload 

func (o *GetPipelinesOK) GetPayload() *GetPipelinesOKBody

func (*GetPipelinesOK) IsClientError 

func (o *GetPipelinesOK) IsClientError() bool

IsClientError returns true when this get pipelines o k response has a 4xx status code

func (*GetPipelinesOK) IsCode 

func (o *GetPipelinesOK) IsCode(code int) bool

IsCode returns true when this get pipelines o k response a status code equal to that given

func (*GetPipelinesOK) IsRedirect 

func (o *GetPipelinesOK) IsRedirect() bool

IsRedirect returns true when this get pipelines o k response has a 3xx status code

func (*GetPipelinesOK) IsServerError 

func (o *GetPipelinesOK) IsServerError() bool

IsServerError returns true when this get pipelines o k response has a 5xx status code

func (*GetPipelinesOK) IsSuccess 

func (o *GetPipelinesOK) IsSuccess() bool

IsSuccess returns true when this get pipelines o k response has a 2xx status code

func (*GetPipelinesOK) String 

func (o *GetPipelinesOK) String() string

type GetPipelinesOKBody 

type GetPipelinesOKBody struct {

	// data
	// Required: true
	Data []*models.Pipeline `json:"data"`

	// pagination
	// Required: true
	Pagination *models.Pagination `json:"pagination"`
}

GetPipelinesOKBody get pipelines o k body swagger:model GetPipelinesOKBody

func (*GetPipelinesOKBody) ContextValidate 

func (o *GetPipelinesOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get pipelines o k body based on the context it is used

func (*GetPipelinesOKBody) MarshalBinary 

func (o *GetPipelinesOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetPipelinesOKBody) UnmarshalBinary 

func (o *GetPipelinesOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetPipelinesOKBody) Validate 

func (o *GetPipelinesOKBody) Validate(formats strfmt.Registry) error

Validate validates this get pipelines o k body

type GetPipelinesParams 

type GetPipelinesParams struct {

	/* ConcoursePipelineName.

	   A pipeline name
	*/
	ConcoursePipelineName *string

	/* EnvironmentCanonical.

	   A list of environments' canonical to filter from
	*/
	EnvironmentCanonical *string

	/* OrganizationCanonical.

	   A canonical of an organization.
	*/
	OrganizationCanonical string

	/* PageIndex.

	   The page number to request. The first page is 1.

	   Format: uint32
	   Default: 1
	*/
	PageIndex *uint32

	/* PageSize.

	   The number of items at most which the response can have.

	   Format: uint32
	   Default: 1000
	*/
	PageSize *uint32

	/* ProjectCanonical.

	   A list of projects' canonical to filter from
	*/
	ProjectCanonical *string

	/* Statuses.

	   List of statuses that you want to filter a pipeline/job with. Pipeline can be either paused or unpaused, but jobs can be started, pending, succeeded, failed, errored, aborted. So if any of a pipeline's job has one of the given status, the associated pipeline will be included in the response.
	*/
	Statuses []string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetPipelinesParams contains all the parameters to send to the API endpoint 

for the get pipelines operation.

Typically these are written to a http.Request.

func NewGetPipelinesParams 

func NewGetPipelinesParams() *GetPipelinesParams

NewGetPipelinesParams creates a new GetPipelinesParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetPipelinesParamsWithContext 

func NewGetPipelinesParamsWithContext(ctx context.Context) *GetPipelinesParams

NewGetPipelinesParamsWithContext creates a new GetPipelinesParams object with the ability to set a context for a request.

func NewGetPipelinesParamsWithHTTPClient 

func NewGetPipelinesParamsWithHTTPClient(client *http.Client) *GetPipelinesParams

NewGetPipelinesParamsWithHTTPClient creates a new GetPipelinesParams object with the ability to set a custom HTTPClient for a request.

func NewGetPipelinesParamsWithTimeout 

func NewGetPipelinesParamsWithTimeout(timeout time.Duration) *GetPipelinesParams

NewGetPipelinesParamsWithTimeout creates a new GetPipelinesParams object with the ability to set a timeout on a request.

func (*GetPipelinesParams) SetConcoursePipelineName 

func (o *GetPipelinesParams) SetConcoursePipelineName(concoursePipelineName *string)

SetConcoursePipelineName adds the concoursePipelineName to the get pipelines params

func (*GetPipelinesParams) SetContext 

func (o *GetPipelinesParams) SetContext(ctx context.Context)

SetContext adds the context to the get pipelines params

func (*GetPipelinesParams) SetDefaults 

func (o *GetPipelinesParams) SetDefaults()

SetDefaults hydrates default values in the get pipelines params (not the query body).

All values with no default are reset to their zero value.

func (*GetPipelinesParams) SetEnvironmentCanonical 

func (o *GetPipelinesParams) SetEnvironmentCanonical(environmentCanonical *string)

SetEnvironmentCanonical adds the environmentCanonical to the get pipelines params

func (*GetPipelinesParams) SetHTTPClient 

func (o *GetPipelinesParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get pipelines params

func (*GetPipelinesParams) SetOrganizationCanonical 

func (o *GetPipelinesParams) SetOrganizationCanonical(organizationCanonical string)

SetOrganizationCanonical adds the organizationCanonical to the get pipelines params

func (*GetPipelinesParams) SetPageIndex 

func (o *GetPipelinesParams) SetPageIndex(pageIndex *uint32)

SetPageIndex adds the pageIndex to the get pipelines params

func (*GetPipelinesParams) SetPageSize 

func (o *GetPipelinesParams) SetPageSize(pageSize *uint32)

SetPageSize adds the pageSize to the get pipelines params

func (*GetPipelinesParams) SetProjectCanonical 

func (o *GetPipelinesParams) SetProjectCanonical(projectCanonical *string)

SetProjectCanonical adds the projectCanonical to the get pipelines params

func (*GetPipelinesParams) SetStatuses 

func (o *GetPipelinesParams) SetStatuses(statuses []string)

SetStatuses adds the statuses to the get pipelines params

func (*GetPipelinesParams) SetTimeout 

func (o *GetPipelinesParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get pipelines params

func (*GetPipelinesParams) WithConcoursePipelineName 

func (o *GetPipelinesParams) WithConcoursePipelineName(concoursePipelineName *string) *GetPipelinesParams

WithConcoursePipelineName adds the concoursePipelineName to the get pipelines params

func (*GetPipelinesParams) WithContext 

func (o *GetPipelinesParams) WithContext(ctx context.Context) *GetPipelinesParams

WithContext adds the context to the get pipelines params

func (*GetPipelinesParams) WithDefaults 

func (o *GetPipelinesParams) WithDefaults() *GetPipelinesParams

WithDefaults hydrates default values in the get pipelines params (not the query body).

All values with no default are reset to their zero value.

func (*GetPipelinesParams) WithEnvironmentCanonical 

func (o *GetPipelinesParams) WithEnvironmentCanonical(environmentCanonical *string) *GetPipelinesParams

WithEnvironmentCanonical adds the environmentCanonical to the get pipelines params

func (*GetPipelinesParams) WithHTTPClient 

func (o *GetPipelinesParams) WithHTTPClient(client *http.Client) *GetPipelinesParams

WithHTTPClient adds the HTTPClient to the get pipelines params

func (*GetPipelinesParams) WithOrganizationCanonical 

func (o *GetPipelinesParams) WithOrganizationCanonical(organizationCanonical string) *GetPipelinesParams

WithOrganizationCanonical adds the organizationCanonical to the get pipelines params

func (*GetPipelinesParams) WithPageIndex 

func (o *GetPipelinesParams) WithPageIndex(pageIndex *uint32) *GetPipelinesParams

WithPageIndex adds the pageIndex to the get pipelines params

func (*GetPipelinesParams) WithPageSize 

func (o *GetPipelinesParams) WithPageSize(pageSize *uint32) *GetPipelinesParams

WithPageSize adds the pageSize to the get pipelines params

func (*GetPipelinesParams) WithProjectCanonical 

func (o *GetPipelinesParams) WithProjectCanonical(projectCanonical *string) *GetPipelinesParams

WithProjectCanonical adds the projectCanonical to the get pipelines params

func (*GetPipelinesParams) WithStatuses 

func (o *GetPipelinesParams) WithStatuses(statuses []string) *GetPipelinesParams

WithStatuses adds the statuses to the get pipelines params

func (*GetPipelinesParams) WithTimeout 

func (o *GetPipelinesParams) WithTimeout(timeout time.Duration) *GetPipelinesParams

WithTimeout adds the timeout to the get pipelines params

func (*GetPipelinesParams) WriteToRequest 

func (o *GetPipelinesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetPipelinesReader 

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

GetPipelinesReader is a Reader for the GetPipelines structure.

func (*GetPipelinesReader) ReadResponse 

func (o *GetPipelinesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetPipelinesUnprocessableEntity 

type GetPipelinesUnprocessableEntity struct {

	/* The length of the response body in octets (8-bit bytes).

	   Format: uint64
	*/
	ContentLength uint64

	Payload *models.ErrorPayload
}

GetPipelinesUnprocessableEntity describes a response with status code 422, with default header values.

All the custom errors that are generated from the Cycloid API

func NewGetPipelinesUnprocessableEntity 

func NewGetPipelinesUnprocessableEntity() *GetPipelinesUnprocessableEntity

NewGetPipelinesUnprocessableEntity creates a GetPipelinesUnprocessableEntity with default headers values

func (*GetPipelinesUnprocessableEntity) Code 

func (o *GetPipelinesUnprocessableEntity) Code() int

Code gets the status code for the get pipelines unprocessable entity response

func (*GetPipelinesUnprocessableEntity) Error 

func (o *GetPipelinesUnprocessableEntity) Error() string

func (*GetPipelinesUnprocessableEntity) GetPayload 

func (o *GetPipelinesUnprocessableEntity) GetPayload() *models.ErrorPayload

func (*GetPipelinesUnprocessableEntity) IsClientError 

func (o *GetPipelinesUnprocessableEntity) IsClientError() bool

IsClientError returns true when this get pipelines unprocessable entity response has a 4xx status code

func (*GetPipelinesUnprocessableEntity) IsCode 

func (o *GetPipelinesUnprocessableEntity) IsCode(code int) bool

IsCode returns true when this get pipelines unprocessable entity response a status code equal to that given

func (*GetPipelinesUnprocessableEntity) IsRedirect 

func (o *GetPipelinesUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this get pipelines unprocessable entity response has a 3xx status code

func (*GetPipelinesUnprocessableEntity) IsServerError 

func (o *GetPipelinesUnprocessableEntity) IsServerError() bool

IsServerError returns true when this get pipelines unprocessable entity response has a 5xx status code

func (*GetPipelinesUnprocessableEntity) IsSuccess 

func (o *GetPipelinesUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this get pipelines unprocessable entity response has a 2xx status code

func (*GetPipelinesUnprocessableEntity) String 

func (o *GetPipelinesUnprocessableEntity) String() string

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.