circleci

package

v1.0.0 Latest Latest Go to latest Published: Oct 1, 2020 License: MIT Imports: 21 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/darkLord19/circleci-v2

Links

Open Source Insights

Documentation ¶

Overview ¶

* CircleCI API * * This describes the resources that make up the CircleCI API v2. API v2 is currently in Preview. Additional documentation for this API can be found in the [API Preview Docs](https://github.com/CircleCI-Public/api-preview-docs/tree/master/docs). Breaking changes to the API will be announced in the [Breaking Changes log](https://github.com/CircleCI-Public/api-preview-docs/blob/master/docs/breaking.md). * * API version: v2 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type Artifact
type ArtifactListResponse
type BasicAuth
type CheckoutKey
type CheckoutKey1
type CheckoutKeyInput
type CheckoutKeyListResponse
type Collaboration
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type EnvironmentVariableListResponse
type EnvironmentVariablePair
type EnvironmentVariablePair1
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type InlineResponse200
type InlineResponse2001
type InlineResponse2001Items
type InlineResponse2002
type InlineResponse2002Items
type InlineResponse2002Metrics
type InlineResponse2002MetricsDurationMetrics
type InlineResponse2003
type InlineResponse2003Items
type InlineResponse200Items
type InlineResponse200Metrics
type InlineResponse200MetricsDurationMetrics
type InsightsApiGetProjectJobRunsOpts
type InsightsApiGetProjectWorkflowJobMetricsOpts
type InsightsApiGetProjectWorkflowMetricsOpts
type InsightsApiGetProjectWorkflowRunsOpts
type InsightsApiService
- func (a *InsightsApiService) GetProjectJobRuns(ctx context.Context, projectSlug string, workflowName string, jobName string, ...) (InlineResponse2003, *http.Response, error)
- func (a *InsightsApiService) GetProjectWorkflowJobMetrics(ctx context.Context, projectSlug string, workflowName string, ...) (InlineResponse2002, *http.Response, error)
- func (a *InsightsApiService) GetProjectWorkflowMetrics(ctx context.Context, projectSlug string, ...) (InlineResponse200, *http.Response, error)
- func (a *InsightsApiService) GetProjectWorkflowRuns(ctx context.Context, projectSlug string, workflowName string, ...) (InlineResponse2001, *http.Response, error)
type Job
type JobApiService
- func (a *JobApiService) CancelJob(ctx context.Context, jobNumber string, projectSlug string) (MessageResponse, *http.Response, error)
- func (a *JobApiService) GetJobArtifacts(ctx context.Context, jobNumber string, projectSlug string) (ArtifactListResponse, *http.Response, error)
- func (a *JobApiService) GetJobDetails(ctx context.Context, jobNumber string, projectSlug string) (JobDetails, *http.Response, error)
- func (a *JobApiService) GetTests(ctx context.Context, jobNumber string, projectSlug string) (TestsResponse, *http.Response, error)
type JobDetails
type JobDetailsContexts
type JobDetailsExecutor
type JobDetailsLatestWorkflow
type JobDetailsMessages
type JobDetailsOrganization
type JobDetailsParallelRuns
type JobDetailsPipeline
type JobDetailsProject
type MessageResponse
type Pipeline
type Pipeline1
type PipelineApiListMyPipelinesOpts
type PipelineApiListPipelinesForProjectOpts
type PipelineApiListPipelinesOpts
type PipelineApiListWorkflowsByPipelineIdOpts
type PipelineApiService
- func (a *PipelineApiService) GetPipelineById(ctx context.Context, pipelineId string) (Pipeline, *http.Response, error)
- func (a *PipelineApiService) GetPipelineByNumber(ctx context.Context, projectSlug string, pipelineNumber string) (Pipeline, *http.Response, error)
- func (a *PipelineApiService) GetPipelineConfigById(ctx context.Context, pipelineId string) (PipelineConfig, *http.Response, error)
- func (a *PipelineApiService) ListMyPipelines(ctx context.Context, projectSlug string, ...) (PipelineListResponse, *http.Response, error)
- func (a *PipelineApiService) ListPipelines(ctx context.Context, orgSlug string, mine bool, ...) (PipelineListResponse, *http.Response, error)
- func (a *PipelineApiService) ListPipelinesForProject(ctx context.Context, projectSlug string, ...) (PipelineListResponse, *http.Response, error)
- func (a *PipelineApiService) ListWorkflowsByPipelineId(ctx context.Context, pipelineId string, ...) (WorkflowListResponse, *http.Response, error)
- func (a *PipelineApiService) TriggerPipeline(ctx context.Context, projectSlug string, ...) (PipelineCreation, *http.Response, error)
type PipelineApiTriggerPipelineOpts
type PipelineConfig
type PipelineCreation
type PipelineListResponse
type PipelineListResponseErrors
type PipelineListResponseTrigger
type PipelineListResponseTriggerActor
type PipelineListResponseVcs
type PipelineListResponseVcsCommit
type PreviewApiCreateCheckoutKeyOpts
type PreviewApiCreateEnvVarOpts
type PreviewApiGetProjectJobRunsOpts
type PreviewApiGetProjectWorkflowJobMetricsOpts
type PreviewApiGetProjectWorkflowMetricsOpts
type PreviewApiGetProjectWorkflowRunsOpts
type PreviewApiListPipelinesOpts
type PreviewApiService
- func (a *PreviewApiService) CancelJob(ctx context.Context, jobNumber string, projectSlug string) (MessageResponse, *http.Response, error)
- func (a *PreviewApiService) CreateCheckoutKey(ctx context.Context, projectSlug string, ...) (CheckoutKey, *http.Response, error)
- func (a *PreviewApiService) CreateEnvVar(ctx context.Context, projectSlug string, ...) (EnvironmentVariablePair, *http.Response, error)
- func (a *PreviewApiService) DeleteCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (MessageResponse, *http.Response, error)
- func (a *PreviewApiService) DeleteEnvVar(ctx context.Context, projectSlug string, name string) (MessageResponse, *http.Response, error)
- func (a *PreviewApiService) GetCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (CheckoutKey, *http.Response, error)
- func (a *PreviewApiService) GetCollaborations(ctx context.Context) ([]Collaboration, *http.Response, error)
- func (a *PreviewApiService) GetCurrentUser(ctx context.Context) (User, *http.Response, error)
- func (a *PreviewApiService) GetEnvVar(ctx context.Context, projectSlug string, name string) (EnvironmentVariablePair, *http.Response, error)
- func (a *PreviewApiService) GetJobArtifacts(ctx context.Context, jobNumber string, projectSlug string) (ArtifactListResponse, *http.Response, error)
- func (a *PreviewApiService) GetJobDetails(ctx context.Context, jobNumber string, projectSlug string) (JobDetails, *http.Response, error)
- func (a *PreviewApiService) GetProjectBySlug(ctx context.Context, projectSlug string) (Project, *http.Response, error)
- func (a *PreviewApiService) GetProjectJobRuns(ctx context.Context, projectSlug string, workflowName string, jobName string, ...) (InlineResponse2003, *http.Response, error)
- func (a *PreviewApiService) GetProjectWorkflowJobMetrics(ctx context.Context, projectSlug string, workflowName string, ...) (InlineResponse2002, *http.Response, error)
- func (a *PreviewApiService) GetProjectWorkflowMetrics(ctx context.Context, projectSlug string, ...) (InlineResponse200, *http.Response, error)
- func (a *PreviewApiService) GetProjectWorkflowRuns(ctx context.Context, projectSlug string, workflowName string, ...) (InlineResponse2001, *http.Response, error)
- func (a *PreviewApiService) GetTests(ctx context.Context, jobNumber string, projectSlug string) (TestsResponse, *http.Response, error)
- func (a *PreviewApiService) GetUser(ctx context.Context, id string) (User, *http.Response, error)
- func (a *PreviewApiService) ListCheckoutKeys(ctx context.Context, projectSlug string) (CheckoutKeyListResponse, *http.Response, error)
- func (a *PreviewApiService) ListEnvVars(ctx context.Context, projectSlug string) (EnvironmentVariableListResponse, *http.Response, error)
- func (a *PreviewApiService) ListPipelines(ctx context.Context, orgSlug string, mine bool, ...) (PipelineListResponse, *http.Response, error)
type Project
type ProjectApiCreateCheckoutKeyOpts
type ProjectApiCreateEnvVarOpts
type ProjectApiService
- func (a *ProjectApiService) CreateCheckoutKey(ctx context.Context, projectSlug string, ...) (CheckoutKey, *http.Response, error)
- func (a *ProjectApiService) CreateEnvVar(ctx context.Context, projectSlug string, ...) (EnvironmentVariablePair, *http.Response, error)
- func (a *ProjectApiService) DeleteCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (MessageResponse, *http.Response, error)
- func (a *ProjectApiService) DeleteEnvVar(ctx context.Context, projectSlug string, name string) (MessageResponse, *http.Response, error)
- func (a *ProjectApiService) GetCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (CheckoutKey, *http.Response, error)
- func (a *ProjectApiService) GetEnvVar(ctx context.Context, projectSlug string, name string) (EnvironmentVariablePair, *http.Response, error)
- func (a *ProjectApiService) GetProjectBySlug(ctx context.Context, projectSlug string) (Project, *http.Response, error)
- func (a *ProjectApiService) ListCheckoutKeys(ctx context.Context, projectSlug string) (CheckoutKeyListResponse, *http.Response, error)
- func (a *ProjectApiService) ListEnvVars(ctx context.Context, projectSlug string) (EnvironmentVariableListResponse, *http.Response, error)
type ProjectVcsInfo
type RerunWorkflowParameters
type TestsResponse
type TestsResponseItems
type TriggerPipelineParameters
type User
type UserApiService
- func (a *UserApiService) GetCollaborations(ctx context.Context) ([]Collaboration, *http.Response, error)
- func (a *UserApiService) GetCurrentUser(ctx context.Context) (User, *http.Response, error)
- func (a *UserApiService) GetUser(ctx context.Context, id string) (User, *http.Response, error)
type Workflow
type Workflow1
type WorkflowApiRerunWorkflowOpts
type WorkflowApiService
- func (a *WorkflowApiService) ApprovePendingApprovalJobById(ctx context.Context, approvalRequestId string, id string) (MessageResponse, *http.Response, error)
- func (a *WorkflowApiService) CancelWorkflow(ctx context.Context, id string) (MessageResponse, *http.Response, error)
- func (a *WorkflowApiService) GetWorkflowById(ctx context.Context, id string) (Workflow, *http.Response, error)
- func (a *WorkflowApiService) ListWorkflowJobs(ctx context.Context, id string) (WorkflowJobListResponse, *http.Response, error)
- func (a *WorkflowApiService) RerunWorkflow(ctx context.Context, id string, ...) (MessageResponse, *http.Response, error)
type WorkflowJobListResponse
type WorkflowListResponse

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a 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")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

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

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

Types ¶

type APIClient ¶

type APIClient struct {
	InsightsApi *InsightsApiService

	JobApi *JobApiService

	PipelineApi *PipelineApiService

	PreviewApi *PreviewApiService

	ProjectApi *ProjectApiService

	UserApi *UserApiService

	WorkflowApi *WorkflowApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the CircleCI API API vv2 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) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

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 swagger 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:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ArtifactListResponse ¶

type ArtifactListResponse struct {
	Items []Artifact `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

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 CheckoutKey ¶

type CheckoutKey struct {
	// A public SSH key.
	PublicKey string `json:"public-key"`
	// The type of checkout key. This may be either `deploy-key` or `github-user-key`.
	Type_ string `json:"type"`
	// An SSH key fingerprint.
	Fingerprint string `json:"fingerprint"`
	// A boolean value that indicates if this key is preferred.
	Preferred bool `json:"preferred"`
	// The date and time the checkout key was created.
	CreatedAt time.Time `json:"created-at"`
}

type CheckoutKey1 ¶

type CheckoutKey1 struct {
	// A public SSH key.
	PublicKey string `json:"public-key"`
	// The type of checkout key. This may be either `deploy-key` or `github-user-key`.
	Type_ string `json:"type"`
	// An SSH key fingerprint.
	Fingerprint string `json:"fingerprint"`
	// A boolean value that indicates if this key is preferred.
	Preferred bool `json:"preferred"`
	// The date and time the checkout key was created.
	CreatedAt time.Time `json:"created-at"`
}

type CheckoutKeyInput ¶

type CheckoutKeyInput struct {
	// The type of checkout key to create. This may be either `deploy-key` or `user-key`.
	Type_ string `json:"type"`
}

type CheckoutKeyListResponse ¶

type CheckoutKeyListResponse struct {
	Items []CheckoutKey1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type Collaboration ¶

type Collaboration struct {
	// The VCS provider
	VcsType string `json:"vcs-type"`
	// The name of the organization
	Name string `json:"name"`
	// URL to the user's avatar on the VCS
	AvatarUrl string `json:"avatar_url"`
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

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

type EnvironmentVariableListResponse ¶

type EnvironmentVariableListResponse struct {
	Items []EnvironmentVariablePair1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type EnvironmentVariablePair ¶

type EnvironmentVariablePair struct {
	// The name of the environment variable.
	Name string `json:"name"`
	// The value of the environment variable.
	Value string `json:"value"`
}

type EnvironmentVariablePair1 ¶

type EnvironmentVariablePair1 struct {
	// The name of the environment variable.
	Name string `json:"name"`
	// The value of the environment variable.
	Value string `json:"value"`
}

type GenericSwaggerError ¶

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

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

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

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

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InlineResponse2001Items ¶

type InlineResponse2001Items struct {
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The duration in seconds of a run.
	Duration int64 `json:"duration"`
	// The date and time the workflow was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time the workflow stopped.
	StoppedAt time.Time `json:"stopped_at"`
	// The number of credits used during execution
	CreditsUsed int64 `json:"credits_used"`
	// Workflow status.
	Status string `json:"status"`
}

type InlineResponse2002Items ¶

type InlineResponse2002Items struct {
	// The name of the job.
	Name string `json:"name"`
	// The start of the aggregation window for job metrics.
	WindowStart time.Time `json:"window_start"`
	// The end of the aggregation window for job metrics.
	WindowEnd time.Time                  `json:"window_end"`
	Metrics   *InlineResponse2002Metrics `json:"metrics"`
}

type InlineResponse2002Metrics ¶

type InlineResponse2002Metrics struct {
	// The ratio of successful runs / total runs.
	SuccessRate float32 `json:"success_rate"`
	// The total number of runs.
	TotalRuns int64 `json:"total_runs"`
	// The number of failed runs.
	FailedRuns int64 `json:"failed_runs"`
	// The number of successful runs.
	SuccessfulRuns int64 `json:"successful_runs"`
	// The average number of job runs per day.
	Throughput float32 `json:"throughput"`
	// The total credits consumed by the job in the aggregation window.
	TotalCreditsUsed int64                                     `json:"total_credits_used"`
	DurationMetrics  *InlineResponse2002MetricsDurationMetrics `json:"duration_metrics"`
}

Metrics relating to a workflow job's runs.

type InlineResponse2002MetricsDurationMetrics ¶

type InlineResponse2002MetricsDurationMetrics struct {
	// The minimum duration, in seconds, among a group of runs.
	Min int64 `json:"min"`
	// The mean duration, in seconds, among a group of runs.
	Mean int64 `json:"mean"`
	// The median duration, in seconds, among a group of runs.
	Median int64 `json:"median"`
	// The 95th percentile duration, in seconds, among a group of runs.
	P95 int64 `json:"p95"`
	// The max duration, in seconds, among a group of runs.
	Max int64 `json:"max"`
	// The standard deviation, in seconds, among a group of runs.
	StandardDeviation float32 `json:"standard_deviation"`
}

Metrics relating to the duration of runs for a workflow job.

type InlineResponse2003Items ¶

type InlineResponse2003Items struct {
	// The unique ID of the job.
	Id string `json:"id"`
	// The date and time the job started.
	StartedAt time.Time `json:"started_at"`
	// The time when the job stopped.
	StoppedAt time.Time `json:"stopped_at"`
	// Job status.
	Status string `json:"status"`
	// The number of credits used during execution
	CreditsUsed int64 `json:"credits_used"`
}

type InlineResponse200Items ¶

type InlineResponse200Items struct {
	// The name of the workflow.
	Name string `json:"name"`
	// The start of the aggregation window for workflow metrics.
	WindowStart time.Time `json:"window_start"`
	// The end of the aggregation window for workflow metrics.
	WindowEnd time.Time                 `json:"window_end"`
	Metrics   *InlineResponse200Metrics `json:"metrics"`
}

type InlineResponse200Metrics ¶

type InlineResponse200Metrics struct {
	// The ratio of successful runs / total runs.
	SuccessRate float32 `json:"success_rate"`
	// The total number of runs.
	TotalRuns int64 `json:"total_runs"`
	// The number of failed runs.
	FailedRuns int64 `json:"failed_runs"`
	// The number of successful runs.
	SuccessfulRuns int64 `json:"successful_runs"`
	// The average number of workflow runs per day.
	Throughput float32 `json:"throughput"`
	// The mean time to recovery (mean time between failures and their next success) in seconds.
	Mttr int64 `json:"mttr"`
	// The total credits consumed by the workflow in the aggregation window.
	TotalCreditsUsed int64                                    `json:"total_credits_used"`
	DurationMetrics  *InlineResponse200MetricsDurationMetrics `json:"duration_metrics"`
}

Metrics relating to a workflow's runs.

type InlineResponse200MetricsDurationMetrics ¶

type InlineResponse200MetricsDurationMetrics struct {
	// The minimum duration, in seconds, among a group of runs.
	Min int64 `json:"min"`
	// The mean duration, in seconds, among a group of runs.
	Mean int64 `json:"mean"`
	// The median duration, in seconds, among a group of runs.
	Median int64 `json:"median"`
	// The 95th percentile duration, in seconds, among a group of runs.
	P95 int64 `json:"p95"`
	// The max duration, in seconds, among a group of runs.
	Max int64 `json:"max"`
	// The standard deviation, in seconds, among a group of runs.
	StandardDeviation float32 `json:"standard_deviation"`
}

Metrics relating to the duration of runs for a workflow.

type InsightsApiGetProjectJobRunsOpts ¶

type InsightsApiGetProjectJobRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type InsightsApiGetProjectWorkflowJobMetricsOpts ¶

type InsightsApiGetProjectWorkflowJobMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type InsightsApiGetProjectWorkflowMetricsOpts ¶

type InsightsApiGetProjectWorkflowMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type InsightsApiGetProjectWorkflowRunsOpts ¶

type InsightsApiGetProjectWorkflowRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type InsightsApiService ¶

type InsightsApiService service

func (*InsightsApiService) GetProjectJobRuns ¶

func (a *InsightsApiService) GetProjectJobRuns(ctx context.Context, projectSlug string, workflowName string, jobName string, startDate time.Time, endDate time.Time, localVarOptionals *InsightsApiGetProjectJobRunsOpts) (InlineResponse2003, *http.Response, error)

func (*InsightsApiService) GetProjectWorkflowJobMetrics ¶

func (a *InsightsApiService) GetProjectWorkflowJobMetrics(ctx context.Context, projectSlug string, workflowName string, localVarOptionals *InsightsApiGetProjectWorkflowJobMetricsOpts) (InlineResponse2002, *http.Response, error)

func (*InsightsApiService) GetProjectWorkflowMetrics ¶

func (a *InsightsApiService) GetProjectWorkflowMetrics(ctx context.Context, projectSlug string, localVarOptionals *InsightsApiGetProjectWorkflowMetricsOpts) (InlineResponse200, *http.Response, error)

func (*InsightsApiService) GetProjectWorkflowRuns ¶

func (a *InsightsApiService) GetProjectWorkflowRuns(ctx context.Context, projectSlug string, workflowName string, startDate time.Time, endDate time.Time, localVarOptionals *InsightsApiGetProjectWorkflowRunsOpts) (InlineResponse2001, *http.Response, error)

type Job ¶

type Job struct {
	// The unique ID of the user.
	CanceledBy string `json:"canceled_by,omitempty"`
	// A sequence of the unique job IDs for the jobs that this job depends upon in the workflow.
	Dependencies []string `json:"dependencies"`
	// The number of the job.
	JobNumber int64 `json:"job_number,omitempty"`
	// The unique ID of the job.
	Id string `json:"id"`
	// The date and time the job started.
	StartedAt time.Time `json:"started_at"`
	// The name of the job.
	Name string `json:"name"`
	// The unique ID of the user.
	ApprovedBy string `json:"approved_by,omitempty"`
	// The project-slug for the job.
	ProjectSlug string `json:"project_slug"`
	// The current status of the job.
	Status *string `json:"status"`
	// The type of job.
	Type_ string `json:"type"`
	// The time when the job stopped.
	StoppedAt time.Time `json:"stopped_at,omitempty"`
	// The unique ID of the job.
	ApprovalRequestId string `json:"approval_request_id,omitempty"`
}

Job

type JobApiService ¶

type JobApiService service

func (*JobApiService) CancelJob ¶

func (a *JobApiService) CancelJob(ctx context.Context, jobNumber string, projectSlug string) (MessageResponse, *http.Response, error)

JobApiService Cancel job Cancel job with a given job number.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return MessageResponse

func (*JobApiService) GetJobArtifacts ¶

func (a *JobApiService) GetJobArtifacts(ctx context.Context, jobNumber string, projectSlug string) (ArtifactListResponse, *http.Response, error)

JobApiService Get a job's artifacts Returns a job's artifacts.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return ArtifactListResponse

func (*JobApiService) GetJobDetails ¶

func (a *JobApiService) GetJobDetails(ctx context.Context, jobNumber string, projectSlug string) (JobDetails, *http.Response, error)

JobApiService Get job details Returns job details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return JobDetails

func (*JobApiService) GetTests ¶

func (a *JobApiService) GetTests(ctx context.Context, jobNumber string, projectSlug string) (TestsResponse, *http.Response, error)

JobApiService Get test metadata Get test metadata for a build.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return TestsResponse

type JobDetailsExecutor ¶

type JobDetailsExecutor struct {
	// Executor type.
	Type_ string `json:"type"`
	// Resource class name.
	ResourceClass string `json:"resource_class"`
}

Information about executor used for a job.

type JobDetailsLatestWorkflow ¶

type JobDetailsLatestWorkflow struct {
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The name of the workflow.
	Name string `json:"name"`
}

Info about the latest workflow the job was a part of.

type JobDetailsMessages ¶

type JobDetailsMessages struct {
	// Message type.
	Type_ string `json:"type"`
	// Information describing message.
	Message string `json:"message"`
	// Value describing the reason for message to be added to the job.
	Reason string `json:"reason,omitempty"`
}

Message from CircleCI execution platform.

type JobDetailsPipeline ¶

type JobDetailsPipeline struct {
	// The unique ID of the pipeline.
	Id string `json:"id"`
}

Info about a pipeline the job is a part of.

type PipelineApiListMyPipelinesOpts ¶

type PipelineApiListMyPipelinesOpts struct {
	PageToken optional.String
}

type PipelineApiListPipelinesForProjectOpts ¶

type PipelineApiListPipelinesForProjectOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type PipelineApiListPipelinesOpts ¶

type PipelineApiListPipelinesOpts struct {
	PageToken optional.String
}

type PipelineApiListWorkflowsByPipelineIdOpts ¶

type PipelineApiListWorkflowsByPipelineIdOpts struct {
	PageToken optional.String
}

type PipelineApiService ¶

type PipelineApiService service

func (*PipelineApiService) GetPipelineById ¶

func (a *PipelineApiService) GetPipelineById(ctx context.Context, pipelineId string) (Pipeline, *http.Response, error)

PipelineApiService Get a pipeline Returns a pipeline by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pipelineId The unique ID of the pipeline.

@return Pipeline

func (*PipelineApiService) GetPipelineByNumber ¶

func (a *PipelineApiService) GetPipelineByNumber(ctx context.Context, projectSlug string, pipelineNumber string) (Pipeline, *http.Response, error)

PipelineApiService Get a pipeline Returns a pipeline by number.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param pipelineNumber The number of the pipeline.

@return Pipeline

func (*PipelineApiService) GetPipelineConfigById ¶

func (a *PipelineApiService) GetPipelineConfigById(ctx context.Context, pipelineId string) (PipelineConfig, *http.Response, error)

PipelineApiService Get a pipeline's configuration Returns a pipeline's configuration by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param pipelineId The unique ID of the pipeline.

@return PipelineConfig

func (*PipelineApiService) ListMyPipelines ¶

func (a *PipelineApiService) ListMyPipelines(ctx context.Context, projectSlug string, localVarOptionals *PipelineApiListMyPipelinesOpts) (PipelineListResponse, *http.Response, error)

func (*PipelineApiService) ListPipelines ¶

func (a *PipelineApiService) ListPipelines(ctx context.Context, orgSlug string, mine bool, localVarOptionals *PipelineApiListPipelinesOpts) (PipelineListResponse, *http.Response, error)

func (*PipelineApiService) ListPipelinesForProject ¶

func (a *PipelineApiService) ListPipelinesForProject(ctx context.Context, projectSlug string, localVarOptionals *PipelineApiListPipelinesForProjectOpts) (PipelineListResponse, *http.Response, error)

func (*PipelineApiService) ListWorkflowsByPipelineId ¶

func (a *PipelineApiService) ListWorkflowsByPipelineId(ctx context.Context, pipelineId string, localVarOptionals *PipelineApiListWorkflowsByPipelineIdOpts) (WorkflowListResponse, *http.Response, error)

func (*PipelineApiService) TriggerPipeline ¶

func (a *PipelineApiService) TriggerPipeline(ctx context.Context, projectSlug string, localVarOptionals *PipelineApiTriggerPipelineOpts) (PipelineCreation, *http.Response, error)

type PipelineApiTriggerPipelineOpts ¶

type PipelineApiTriggerPipelineOpts struct {
	Body                optional.Interface
	XAttributionLogin   optional.String
	XAttributionActorId optional.String
}

type PipelineConfig ¶

type PipelineConfig struct {
	// The source configuration for the pipeline, before any config compilation has been performed. If there is no config, then this field will be empty.
	Source string `json:"source"`
	// The compiled configuration for the pipeline, after all orb expansion has been performed. If there were errors processing the pipeline's configuration, then this field may be empty.
	Compiled string `json:"compiled"`
}

The configuration strings for the pipeline.

type PipelineListResponseErrors ¶

type PipelineListResponseErrors struct {
	// The type of error.
	Type_ string `json:"type"`
	// A human-readable error message.
	Message string `json:"message"`
}

An error with a type and message.

type PipelineListResponseTrigger ¶

type PipelineListResponseTrigger struct {
	// The type of trigger.
	Type_ string `json:"type"`
	// The date and time the trigger was received.
	ReceivedAt time.Time                         `json:"received_at"`
	Actor      *PipelineListResponseTriggerActor `json:"actor"`
}

A summary of the trigger.

type PipelineListResponseTriggerActor ¶

type PipelineListResponseTriggerActor struct {
	// The login information for the user on the VCS.
	Login string `json:"login"`
	// URL to the user's avatar on the VCS
	AvatarUrl string `json:"avatar_url"`
}

The user who triggered the Pipeline.

type PipelineListResponseVcs ¶

type PipelineListResponseVcs struct {
	// Name of the VCS provider (e.g. GitHub, Bitbucket).
	ProviderName string `json:"provider_name"`
	// URL for the repository where the trigger originated. For fork-PR pipelines, this is the URL to the fork. For other pipelines the `origin_` and `target_repository_url`s will be the same.
	OriginRepositoryUrl string `json:"origin_repository_url"`
	// URL for the repository the trigger targets (i.e. the repository where the PR will be merged). For fork-PR pipelines, this is the URL to the parent repo. For other pipelines, the `origin_` and `target_repository_url`s will be the same.
	TargetRepositoryUrl string `json:"target_repository_url"`
	// The code revision the pipeline ran.
	Revision string `json:"revision"`
	// The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Branch string `json:"branch,omitempty"`
	// The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Tag    string                         `json:"tag,omitempty"`
	Commit *PipelineListResponseVcsCommit `json:"commit,omitempty"`
}

VCS information for the pipeline.

type PipelineListResponseVcsCommit ¶

type PipelineListResponseVcsCommit struct {
	// The subject of the commit message.
	Subject string `json:"subject"`
	// The body of the commit message.
	Body string `json:"body"`
}

The latest commit in the pipeline.

type PreviewApiCreateCheckoutKeyOpts ¶

type PreviewApiCreateCheckoutKeyOpts struct {
	Body optional.Interface
}

type PreviewApiCreateEnvVarOpts ¶

type PreviewApiCreateEnvVarOpts struct {
	Body optional.Interface
}

type PreviewApiGetProjectJobRunsOpts ¶

type PreviewApiGetProjectJobRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type PreviewApiGetProjectWorkflowJobMetricsOpts ¶

type PreviewApiGetProjectWorkflowJobMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type PreviewApiGetProjectWorkflowMetricsOpts ¶

type PreviewApiGetProjectWorkflowMetricsOpts struct {
	PageToken optional.String
	Branch    optional.String
}

type PreviewApiGetProjectWorkflowRunsOpts ¶

type PreviewApiGetProjectWorkflowRunsOpts struct {
	Branch    optional.String
	PageToken optional.String
}

type PreviewApiListPipelinesOpts ¶

type PreviewApiListPipelinesOpts struct {
	PageToken optional.String
}

type PreviewApiService ¶

type PreviewApiService service

func (*PreviewApiService) CancelJob ¶

func (a *PreviewApiService) CancelJob(ctx context.Context, jobNumber string, projectSlug string) (MessageResponse, *http.Response, error)

PreviewApiService Cancel job Cancel job with a given job number.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return MessageResponse

func (*PreviewApiService) CreateCheckoutKey ¶

func (a *PreviewApiService) CreateCheckoutKey(ctx context.Context, projectSlug string, localVarOptionals *PreviewApiCreateCheckoutKeyOpts) (CheckoutKey, *http.Response, error)

func (*PreviewApiService) CreateEnvVar ¶

func (a *PreviewApiService) CreateEnvVar(ctx context.Context, projectSlug string, localVarOptionals *PreviewApiCreateEnvVarOpts) (EnvironmentVariablePair, *http.Response, error)

func (*PreviewApiService) DeleteCheckoutKey ¶

func (a *PreviewApiService) DeleteCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (MessageResponse, *http.Response, error)

PreviewApiService Delete a checkout key Deletes the checkout key.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param fingerprint An SSH key fingerprint.

@return MessageResponse

func (*PreviewApiService) DeleteEnvVar ¶

func (a *PreviewApiService) DeleteEnvVar(ctx context.Context, projectSlug string, name string) (MessageResponse, *http.Response, error)

PreviewApiService Delete an environment variable Deletes the environment variable named :name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param name The name of the environment variable.

@return MessageResponse

func (*PreviewApiService) GetCheckoutKey ¶

func (a *PreviewApiService) GetCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (CheckoutKey, *http.Response, error)

PreviewApiService Get a checkout key Returns an individual checkout key.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param fingerprint An SSH key fingerprint.

@return CheckoutKey

func (*PreviewApiService) GetCollaborations ¶

func (a *PreviewApiService) GetCollaborations(ctx context.Context) ([]Collaboration, *http.Response, error)

PreviewApiService Collaborations Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the current user's account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Collaboration

func (*PreviewApiService) GetCurrentUser ¶

func (a *PreviewApiService) GetCurrentUser(ctx context.Context) (User, *http.Response, error)

PreviewApiService User Information Provides information about the user that is currently signed in.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return User

func (*PreviewApiService) GetEnvVar ¶

func (a *PreviewApiService) GetEnvVar(ctx context.Context, projectSlug string, name string) (EnvironmentVariablePair, *http.Response, error)

PreviewApiService Get a masked environment variable Returns the masked value of environment variable :name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param name The name of the environment variable.

@return EnvironmentVariablePair

func (*PreviewApiService) GetJobArtifacts ¶

func (a *PreviewApiService) GetJobArtifacts(ctx context.Context, jobNumber string, projectSlug string) (ArtifactListResponse, *http.Response, error)

PreviewApiService Get a job's artifacts Returns a job's artifacts.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return ArtifactListResponse

func (*PreviewApiService) GetJobDetails ¶

func (a *PreviewApiService) GetJobDetails(ctx context.Context, jobNumber string, projectSlug string) (JobDetails, *http.Response, error)

PreviewApiService Get job details Returns job details.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return JobDetails

func (*PreviewApiService) GetProjectBySlug ¶

func (a *PreviewApiService) GetProjectBySlug(ctx context.Context, projectSlug string) (Project, *http.Response, error)

PreviewApiService Get a project Retrieves a project by project slug.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return Project

func (*PreviewApiService) GetProjectJobRuns ¶

func (a *PreviewApiService) GetProjectJobRuns(ctx context.Context, projectSlug string, workflowName string, jobName string, startDate time.Time, endDate time.Time, localVarOptionals *PreviewApiGetProjectJobRunsOpts) (InlineResponse2003, *http.Response, error)

func (*PreviewApiService) GetProjectWorkflowJobMetrics ¶

func (a *PreviewApiService) GetProjectWorkflowJobMetrics(ctx context.Context, projectSlug string, workflowName string, localVarOptionals *PreviewApiGetProjectWorkflowJobMetricsOpts) (InlineResponse2002, *http.Response, error)

func (*PreviewApiService) GetProjectWorkflowMetrics ¶

func (a *PreviewApiService) GetProjectWorkflowMetrics(ctx context.Context, projectSlug string, localVarOptionals *PreviewApiGetProjectWorkflowMetricsOpts) (InlineResponse200, *http.Response, error)

func (*PreviewApiService) GetProjectWorkflowRuns ¶

func (a *PreviewApiService) GetProjectWorkflowRuns(ctx context.Context, projectSlug string, workflowName string, startDate time.Time, endDate time.Time, localVarOptionals *PreviewApiGetProjectWorkflowRunsOpts) (InlineResponse2001, *http.Response, error)

func (*PreviewApiService) GetTests ¶

func (a *PreviewApiService) GetTests(ctx context.Context, jobNumber string, projectSlug string) (TestsResponse, *http.Response, error)

PreviewApiService Get test metadata Get test metadata for a build.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobNumber The number of the job.
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return TestsResponse

func (*PreviewApiService) GetUser ¶

func (a *PreviewApiService) GetUser(ctx context.Context, id string) (User, *http.Response, error)

PreviewApiService User Information Provides information about the user with the given ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique ID of the user.

@return User

func (*PreviewApiService) ListCheckoutKeys ¶

func (a *PreviewApiService) ListCheckoutKeys(ctx context.Context, projectSlug string) (CheckoutKeyListResponse, *http.Response, error)

PreviewApiService Get all checkout keys Returns a sequence of checkout keys for `:project`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return CheckoutKeyListResponse

func (*PreviewApiService) ListEnvVars ¶

func (a *PreviewApiService) ListEnvVars(ctx context.Context, projectSlug string) (EnvironmentVariableListResponse, *http.Response, error)

PreviewApiService List all environment variables Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return EnvironmentVariableListResponse

func (*PreviewApiService) ListPipelines ¶

func (a *PreviewApiService) ListPipelines(ctx context.Context, orgSlug string, mine bool, localVarOptionals *PreviewApiListPipelinesOpts) (PipelineListResponse, *http.Response, error)

type Project ¶

type Project struct {
	// Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
	Slug string `json:"slug"`
	// The name of the project
	Name string `json:"name"`
	// The name of the organization the project belongs to
	OrganizationName string          `json:"organization_name"`
	VcsInfo          *ProjectVcsInfo `json:"vcs_info"`
}

NOTE: The definition of Project is subject to change.

type ProjectApiCreateCheckoutKeyOpts ¶

type ProjectApiCreateCheckoutKeyOpts struct {
	Body optional.Interface
}

type ProjectApiCreateEnvVarOpts ¶

type ProjectApiCreateEnvVarOpts struct {
	Body optional.Interface
}

type ProjectApiService ¶

type ProjectApiService service

func (*ProjectApiService) CreateCheckoutKey ¶

func (a *ProjectApiService) CreateCheckoutKey(ctx context.Context, projectSlug string, localVarOptionals *ProjectApiCreateCheckoutKeyOpts) (CheckoutKey, *http.Response, error)

func (*ProjectApiService) CreateEnvVar ¶

func (a *ProjectApiService) CreateEnvVar(ctx context.Context, projectSlug string, localVarOptionals *ProjectApiCreateEnvVarOpts) (EnvironmentVariablePair, *http.Response, error)

func (*ProjectApiService) DeleteCheckoutKey ¶

func (a *ProjectApiService) DeleteCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (MessageResponse, *http.Response, error)

ProjectApiService Delete a checkout key Deletes the checkout key.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param fingerprint An SSH key fingerprint.

@return MessageResponse

func (*ProjectApiService) DeleteEnvVar ¶

func (a *ProjectApiService) DeleteEnvVar(ctx context.Context, projectSlug string, name string) (MessageResponse, *http.Response, error)

ProjectApiService Delete an environment variable Deletes the environment variable named :name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param name The name of the environment variable.

@return MessageResponse

func (*ProjectApiService) GetCheckoutKey ¶

func (a *ProjectApiService) GetCheckoutKey(ctx context.Context, projectSlug string, fingerprint string) (CheckoutKey, *http.Response, error)

ProjectApiService Get a checkout key Returns an individual checkout key.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param fingerprint An SSH key fingerprint.

@return CheckoutKey

func (*ProjectApiService) GetEnvVar ¶

func (a *ProjectApiService) GetEnvVar(ctx context.Context, projectSlug string, name string) (EnvironmentVariablePair, *http.Response, error)

ProjectApiService Get a masked environment variable Returns the masked value of environment variable :name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.
@param name The name of the environment variable.

@return EnvironmentVariablePair

func (*ProjectApiService) GetProjectBySlug ¶

func (a *ProjectApiService) GetProjectBySlug(ctx context.Context, projectSlug string) (Project, *http.Response, error)

ProjectApiService Get a project Retrieves a project by project slug.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return Project

func (*ProjectApiService) ListCheckoutKeys ¶

func (a *ProjectApiService) ListCheckoutKeys(ctx context.Context, projectSlug string) (CheckoutKeyListResponse, *http.Response, error)

ProjectApiService Get all checkout keys Returns a sequence of checkout keys for `:project`.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return CheckoutKeyListResponse

func (*ProjectApiService) ListEnvVars ¶

func (a *ProjectApiService) ListEnvVars(ctx context.Context, projectSlug string) (EnvironmentVariableListResponse, *http.Response, error)

ProjectApiService List all environment variables Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param projectSlug Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped.

@return EnvironmentVariableListResponse

type ProjectVcsInfo ¶

type ProjectVcsInfo struct {
	// URL to the repository hosting the project's code
	VcsUrl string `json:"vcs_url"`
	// The VCS provider
	Provider      string `json:"provider"`
	DefaultBranch string `json:"default_branch"`
}

Information about the VCS that hosts the project source code.

type RerunWorkflowParameters ¶

type RerunWorkflowParameters struct {
	// A list of job IDs to rerun.
	Jobs []string `json:"jobs,omitempty"`
	// Whether to rerun the workflow from the failed job. Mutually exclusive with the jobs parameter.
	FromFailed bool `json:"from_failed,omitempty"`
}

The information you can supply when rerunning a workflow.

type TestsResponse ¶

type TestsResponse struct {
	Items []TestsResponseItems `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type TestsResponseItems ¶

type TestsResponseItems struct {
	// The failure message associated with the test.
	Message string `json:"message"`
	// The program that generated the test results
	Source string `json:"source"`
	// The time it took to run the test in seconds
	RunTime float64 `json:"run_time"`
	// The file in which the test is defined.
	File string `json:"file"`
	// Indication of whether the test succeeded.
	Result string `json:"result"`
	// The name of the test.
	Name string `json:"name"`
	// The programmatic location of the test.
	Classname string `json:"classname"`
}

type TriggerPipelineParameters ¶

type TriggerPipelineParameters struct {
	// The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Branch string `json:"branch,omitempty"`
	// The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that `branch` and `tag` are mutually exclusive.
	Tag string `json:"tag,omitempty"`
	// An object containing pipeline parameters and their values.
	Parameters map[string]string `json:"parameters,omitempty"`
}

The information you can supply when triggering a pipeline.

type User ¶

type User struct {
	// The unique ID of the user.
	Id string `json:"id"`
	// The login information for the user on the VCS.
	Login string `json:"login"`
	// The name of the user.
	Name string `json:"name"`
}

type UserApiService ¶

type UserApiService service

func (*UserApiService) GetCollaborations ¶

func (a *UserApiService) GetCollaborations(ctx context.Context) ([]Collaboration, *http.Response, error)

UserApiService Collaborations Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the current user's account

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Collaboration

func (*UserApiService) GetCurrentUser ¶

func (a *UserApiService) GetCurrentUser(ctx context.Context) (User, *http.Response, error)

UserApiService User Information Provides information about the user that is currently signed in.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return User

func (*UserApiService) GetUser ¶

func (a *UserApiService) GetUser(ctx context.Context, id string) (User, *http.Response, error)

UserApiService User Information Provides information about the user with the given ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique ID of the user.

@return User

type Workflow ¶

type Workflow struct {
	// The ID of the pipeline this workflow belongs to.
	PipelineId string `json:"pipeline_id"`
	CanceledBy string `json:"canceled_by,omitempty"`
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The name of the workflow.
	Name string `json:"name"`
	// The project-slug for the pipeline this workflow belongs to.
	ProjectSlug string `json:"project_slug"`
	ErroredBy   string `json:"errored_by,omitempty"`
	// The current status of the workflow.
	Status    string `json:"status"`
	StartedBy string `json:"started_by"`
	// The number of the pipeline this workflow belongs to.
	PipelineNumber int64 `json:"pipeline_number"`
	// The date and time the workflow was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time the workflow stopped.
	StoppedAt time.Time `json:"stopped_at"`
}

A workflow

type Workflow1 ¶

type Workflow1 struct {
	// The ID of the pipeline this workflow belongs to.
	PipelineId string `json:"pipeline_id"`
	CanceledBy string `json:"canceled_by,omitempty"`
	// The unique ID of the workflow.
	Id string `json:"id"`
	// The name of the workflow.
	Name string `json:"name"`
	// The project-slug for the pipeline this workflow belongs to.
	ProjectSlug string `json:"project_slug"`
	ErroredBy   string `json:"errored_by,omitempty"`
	// The current status of the workflow.
	Status    string `json:"status"`
	StartedBy string `json:"started_by"`
	// The number of the pipeline this workflow belongs to.
	PipelineNumber int64 `json:"pipeline_number"`
	// The date and time the workflow was created.
	CreatedAt time.Time `json:"created_at"`
	// The date and time the workflow stopped.
	StoppedAt time.Time `json:"stopped_at"`
}

A workflow

type WorkflowApiRerunWorkflowOpts ¶

type WorkflowApiRerunWorkflowOpts struct {
	Body optional.Interface
}

type WorkflowApiService ¶

type WorkflowApiService service

func (*WorkflowApiService) ApprovePendingApprovalJobById ¶

func (a *WorkflowApiService) ApprovePendingApprovalJobById(ctx context.Context, approvalRequestId string, id string) (MessageResponse, *http.Response, error)

WorkflowApiService Approve a job Approves a pending approval job in a workflow.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param approvalRequestId The ID of the job being approved.
@param id The unique ID of the workflow.

@return MessageResponse

func (*WorkflowApiService) CancelWorkflow ¶

func (a *WorkflowApiService) CancelWorkflow(ctx context.Context, id string) (MessageResponse, *http.Response, error)

WorkflowApiService Cancel a workflow Cancels a running workflow.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique ID of the workflow.

@return MessageResponse

func (*WorkflowApiService) GetWorkflowById ¶

func (a *WorkflowApiService) GetWorkflowById(ctx context.Context, id string) (Workflow, *http.Response, error)

WorkflowApiService Get a workflow Returns summary fields of a workflow by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique ID of the workflow.

@return Workflow

func (*WorkflowApiService) ListWorkflowJobs ¶

func (a *WorkflowApiService) ListWorkflowJobs(ctx context.Context, id string) (WorkflowJobListResponse, *http.Response, error)

WorkflowApiService Get a workflow's jobs Returns a sequence of jobs for a workflow.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The unique ID of the workflow.

@return WorkflowJobListResponse

func (*WorkflowApiService) RerunWorkflow ¶

func (a *WorkflowApiService) RerunWorkflow(ctx context.Context, id string, localVarOptionals *WorkflowApiRerunWorkflowOpts) (MessageResponse, *http.Response, error)

type WorkflowJobListResponse ¶

type WorkflowJobListResponse struct {
	Items []Job `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

type WorkflowListResponse ¶

type WorkflowListResponse struct {
	// A list of workflows.
	Items []Workflow1 `json:"items"`
	// A token to pass as a `page-token` query parameter to return the next page of results.
	NextPageToken string `json:"next_page_token"`
}

A list of workflows and associated pagination token.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func CacheExpires ¶

Types ¶

type APIClient ¶

func NewAPIClient ¶

func (*APIClient) ChangeBasePath ¶

type APIKey ¶

type APIResponse ¶

func NewAPIResponse ¶

func NewAPIResponseWithError ¶

type Artifact ¶

type ArtifactListResponse ¶

type BasicAuth ¶

type CheckoutKey ¶

type CheckoutKey1 ¶

type CheckoutKeyInput ¶

type CheckoutKeyListResponse ¶

type Collaboration ¶

type Configuration ¶

func NewConfiguration ¶

func (*Configuration) AddDefaultHeader ¶

type EnvironmentVariableListResponse ¶

type EnvironmentVariablePair ¶

type EnvironmentVariablePair1 ¶

type GenericSwaggerError ¶

func (GenericSwaggerError) Body ¶

func (GenericSwaggerError) Error ¶

func (GenericSwaggerError) Model ¶

type InlineResponse200 ¶

type InlineResponse2001 ¶

type InlineResponse2001Items ¶

type InlineResponse2002 ¶

type InlineResponse2002Items ¶

type InlineResponse2002Metrics ¶

type InlineResponse2002MetricsDurationMetrics ¶

type InlineResponse2003 ¶

type InlineResponse2003Items ¶

type InlineResponse200Items ¶

type InlineResponse200Metrics ¶

type InlineResponse200MetricsDurationMetrics ¶

type InsightsApiGetProjectJobRunsOpts ¶

type InsightsApiGetProjectWorkflowJobMetricsOpts ¶

type InsightsApiGetProjectWorkflowMetricsOpts ¶

type InsightsApiGetProjectWorkflowRunsOpts ¶

type InsightsApiService ¶

func (*InsightsApiService) GetProjectJobRuns ¶

func (*InsightsApiService) GetProjectWorkflowJobMetrics ¶

func (*InsightsApiService) GetProjectWorkflowMetrics ¶

func (*InsightsApiService) GetProjectWorkflowRuns ¶

type Job ¶

type JobApiService ¶

func (*JobApiService) CancelJob ¶

func (*JobApiService) GetJobArtifacts ¶

func (*JobApiService) GetJobDetails ¶

func (*JobApiService) GetTests ¶

type JobDetails ¶

type JobDetailsContexts ¶

type JobDetailsExecutor ¶

type JobDetailsLatestWorkflow ¶

type JobDetailsMessages ¶

type JobDetailsOrganization ¶

type JobDetailsParallelRuns ¶

type JobDetailsPipeline ¶

type JobDetailsProject ¶

type MessageResponse ¶

type Pipeline ¶

type Pipeline1 ¶

type PipelineApiListMyPipelinesOpts ¶

type PipelineApiListPipelinesForProjectOpts ¶

type PipelineApiListPipelinesOpts ¶

type PipelineApiListWorkflowsByPipelineIdOpts ¶

type PipelineApiService ¶

func (*PipelineApiService) GetPipelineById ¶

func (*PipelineApiService) GetPipelineByNumber ¶

func (*PipelineApiService) GetPipelineConfigById ¶