package
0.4.0
Repository: https://github.com/danielcoman/spin.git
Documentation: pkg.go.dev

# README

Go API client for swagger

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Overview

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

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

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

    "./swagger"

Documentation for API Endpoints

All URIs are relative to https://localhost

ClassMethodHTTP requestDescription
AmazonInfrastructureControllerApiInstanceTypesUsingGETGet /instanceTypesGet instance types
AmazonInfrastructureControllerApiSubnetsUsingGETGet /subnetsGet subnets
AmazonInfrastructureControllerApiVpcsUsingGETGet /vpcsGet VPCs
ApplicationControllerApiCancelPipelineUsingPUTPut /applications/{application}/pipelines/{id}/cancelCancel pipeline
ApplicationControllerApiCancelTaskUsingPUTPut /applications/{application}/tasks/{id}/cancelCancel task
ApplicationControllerApiGetAllApplicationsUsingGETGet /applicationsRetrieve a list of applications
ApplicationControllerApiGetApplicationHistoryUsingGETGet /applications/{application}/historyRetrieve a list of an application's configuration revision history
ApplicationControllerApiGetApplicationUsingGETGet /applications/{application}Retrieve an application's details
ApplicationControllerApiGetPipelineConfigUsingGETGet /applications/{application}/pipelineConfigs/{pipelineName}Retrieve a pipeline configuration
ApplicationControllerApiGetPipelineConfigsForApplicationUsingGETGet /applications/{application}/pipelineConfigsRetrieve a list of an application's pipeline configurations
ApplicationControllerApiGetPipelinesUsingGETGet /applications/{application}/pipelinesRetrieve a list of an application's pipeline executions
ApplicationControllerApiGetStrategyConfigUsingGETGet /applications/{application}/strategyConfigs/{strategyName}Retrieve a pipeline strategy configuration
ApplicationControllerApiGetStrategyConfigsForApplicationUsingGETGet /applications/{application}/strategyConfigsRetrieve a list of an application's pipeline strategy configurations
ApplicationControllerApiGetTaskDetailsUsingGETGet /applications/{application}/tasks/{id}/details/{taskDetailsId}Get task details
ApplicationControllerApiGetTaskUsingGETGet /applications/{application}/tasks/{id}Get task
ApplicationControllerApiGetTasksUsingGETGet /applications/{application}/tasksRetrieve a list of an application's tasks
ApplicationControllerApiInvokePipelineConfigUsingPOSTPost /applications/{application}/pipelineConfigs/{pipelineName}Invoke pipeline config
ApplicationControllerApiTaskUsingPOSTPost /applications/{application}/tasksCreate task
ArtifactControllerApiAllUsingGETGet /artifacts/credentialsRetrieve the list of artifact accounts configured in Clouddriver.
AuditEventsMvcEndpointApiFindByPrincipalAndAfterAndTypeUsingGETGet /auditeventsfindByPrincipalAndAfterAndType
AuditEventsMvcEndpointApiFindByPrincipalAndAfterAndTypeUsingGET1Get /auditevents.jsonfindByPrincipalAndAfterAndType
AuthControllerApiGetServiceAccountsUsingGETGet /auth/user/serviceAccountsGet service accounts
AuthControllerApiLoggedOutUsingGETGet /auth/loggedOutGet logged out message
AuthControllerApiRedirectUsingGETGet /auth/redirectRedirect to Deck
AuthControllerApiSyncUsingPOSTPost /auth/roles/syncSync user roles
AuthControllerApiUserUsingGETGet /auth/userGet user
BakeControllerApiBakeOptionsUsingGETGet /bakery/options/{cloudProvider}Retrieve a list of available bakery base images for a given cloud provider
BakeControllerApiBakeOptionsUsingGET1Get /bakery/optionsRetrieve a list of available bakery base images, grouped by cloud provider
BakeControllerApiLookupLogsUsingGETGet /bakery/logs/{region}/{statusId}Retrieve the logs for a given bake
BuildControllerApiGetBuildMastersUsingGETGet /v2/buildsGet build masters
BuildControllerApiGetBuildUsingGETGet /v2/builds/{buildMaster}/build/{number}/**Get build for build master
BuildControllerApiGetBuildsUsingGETGet /v2/builds/{buildMaster}/builds/**Get builds for build master
BuildControllerApiGetJobConfigUsingGETGet /v2/builds/{buildMaster}/jobs/**Get job config
BuildControllerApiGetJobsForBuildMasterUsingGETGet /v2/builds/{buildMaster}/jobsGet jobs for build master
BuildControllerApiV3GetBuildMastersUsingGETGet /v3/buildsGet build masters
BuildControllerApiV3GetBuildUsingGETGet /v3/builds/{buildMaster}/build/{number}Get build for build master
BuildControllerApiV3GetBuildsUsingGETGet /v3/builds/{buildMaster}/buildsGet builds for build master
BuildControllerApiV3GetJobConfigUsingGETGet /v3/builds/{buildMaster}/jobGet job config
BuildControllerApiV3GetJobsForBuildMasterUsingGETGet /v3/builds/{buildMaster}/jobsGet jobs for build master
ClusterControllerApiGetClusterLoadBalancersUsingGETGet /applications/{application}/clusters/{account}/{clusterName}/{type}/loadBalancersRetrieve a cluster's loadbalancers
ClusterControllerApiGetClustersUsingGETGet /applications/{application}/clusters/{account}/{clusterName}Retrieve a cluster's details
ClusterControllerApiGetClustersUsingGET1Get /applications/{application}/clusters/{account}Retrieve a list of clusters for an account
ClusterControllerApiGetClustersUsingGET2Get /applications/{application}/clustersRetrieve a list of cluster names for an application, grouped by account
ClusterControllerApiGetScalingActivitiesUsingGETGet /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}/scalingActivitiesRetrieve a list of scaling activities for a server group
ClusterControllerApiGetServerGroupsUsingGETGet /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}Retrieve a server group's details
ClusterControllerApiGetServerGroupsUsingGET1Get /applications/{application}/clusters/{account}/{clusterName}/serverGroupsRetrieve a list of server groups for a cluster
ClusterControllerApiGetTargetServerGroupUsingGETGet /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target}Retrieve a server group that matches a target coordinate (e.g., newest, ancestor) relative to a cluster
CredentialsControllerApiGetAccountUsingGETGet /credentials/{account}Retrieve an account's details
CredentialsControllerApiGetAccountsUsingGETGet /credentialsRetrieve a list of accounts
EcsServerGroupEventsControllerApiGetEventsUsingGETGet /applications/{application}/serverGroups/{account}/{serverGroupName}/eventsRetrieves a list of events for a server group
ExecutionsControllerApiGetLatestExecutionsByConfigIdsUsingGETGet /executionsRetrieves an ad-hoc collection of executions based on a number of user-supplied parameters. Either executionIds or pipelineConfigIds must be supplied in order to return any results. If both are supplied, an exception will be thrown.
ExecutionsControllerApiSearchForPipelineExecutionsByTriggerUsingGETGet /applications/{application}/executions/searchSearch for pipeline executions using a combination of criteria. The returned list is sorted by buildTime (trigger time) in reverse order so that newer executions are first in the list.
FirewallControllerApiAllByAccountUsingGETGet /firewalls/{account}Retrieve a list of firewalls for a given account, grouped by region
FirewallControllerApiAllUsingGET1Get /firewallsRetrieve a list of firewalls, grouped by account, cloud provider, and region
FirewallControllerApiGetSecurityGroupUsingGETGet /firewalls/{account}/{region}/{name}Retrieve a firewall's details
ImageControllerApiFindImagesUsingGETGet /images/findRetrieve a list of images, filtered by cloud provider, region, and account
ImageControllerApiFindTagsUsingGETGet /images/tagsFind tags
ImageControllerApiGetImageDetailsUsingGETGet /images/{account}/{region}/{imageId}Get image details
InstanceControllerApiGetConsoleOutputUsingGETGet /instances/{account}/{region}/{instanceId}/consoleRetrieve an instance's console output
InstanceControllerApiGetInstanceDetailsUsingGETGet /instances/{account}/{region}/{instanceId}Retrieve an instance's details
JobControllerApiGetJobUsingGETGet /applications/{applicationName}/jobs/{account}/{region}/{name}Get job
JobControllerApiGetJobsUsingGETGet /applications/{applicationName}/jobsGet jobs
LoadBalancerControllerApiGetAllUsingGETGet /loadBalancersRetrieve a list of load balancers for a given cloud provider
LoadBalancerControllerApiGetApplicationLoadBalancersUsingGETGet /applications/{application}/loadBalancersRetrieve a list of load balancers for a given application
LoadBalancerControllerApiGetLoadBalancerDetailsUsingGETGet /loadBalancers/{account}/{region}/{name}Retrieve a load balancer's details as a single element list for a given account, region, cloud provider and load balancer name
LoadBalancerControllerApiGetLoadBalancerUsingGETGet /loadBalancers/{name}Retrieve a load balancer for a given cloud provider
NetworkControllerApiAllByCloudProviderUsingGETGet /networks/{cloudProvider}Retrieve a list of networks for a given cloud provider
NetworkControllerApiAllUsingGET2Get /networksRetrieve a list of networks, grouped by cloud provider
PipelineConfigControllerApiConvertPipelineConfigToPipelineTemplateUsingGETGet /pipelineConfigs/{pipelineConfigId}/convertToTemplateConvert a pipeline config to a pipeline template.
PipelineConfigControllerApiGetAllPipelineConfigsUsingGETGet /pipelineConfigsGet all pipeline configs.
PipelineConfigControllerApiGetPipelineConfigHistoryUsingGETGet /pipelineConfigs/{pipelineConfigId}/historyGet pipeline config history.
PipelineControllerApiCancelPipelineUsingPUT1Put /pipelines/{id}/cancelCancel a pipeline execution
PipelineControllerApiDeletePipelineUsingDELETEDelete /pipelines/{application}/{pipelineName}Delete a pipeline definition
PipelineControllerApiDeletePipelineUsingDELETE1Delete /pipelines/{id}Delete a pipeline execution
PipelineControllerApiEvaluateExpressionForExecutionUsingDELETEDelete /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiEvaluateExpressionForExecutionUsingGETGet /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiEvaluateExpressionForExecutionUsingHEADHead /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiEvaluateExpressionForExecutionUsingOPTIONSOptions /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiEvaluateExpressionForExecutionUsingPATCHPatch /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiEvaluateExpressionForExecutionUsingPUTPut /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiEvaluateExpressionForExecutionViaPOSTUsingPOST1Post /pipelines/{id}/evaluateExpressionEvaluate a pipeline expression using the provided execution as context
PipelineControllerApiGetPipelineLogsUsingGETGet /pipelines/{id}/logsRetrieve pipeline execution logs
PipelineControllerApiGetPipelineUsingGETGet /pipelines/{id}Retrieve a pipeline execution
PipelineControllerApiInvokePipelineConfigUsingPOST1Post /pipelines/{application}/{pipelineNameOrId}Trigger a pipeline execution
PipelineControllerApiInvokePipelineConfigViaEchoUsingPOSTPost /pipelines/v2/{application}/{pipelineNameOrId}Trigger a pipeline execution
PipelineControllerApiPausePipelineUsingPUTPut /pipelines/{id}/pausePause a pipeline execution
PipelineControllerApiRenamePipelineUsingPOSTPost /pipelines/moveRename a pipeline definition
PipelineControllerApiRestartStageUsingPUTPut /pipelines/{id}/stages/{stageId}/restartRestart a stage execution
PipelineControllerApiResumePipelineUsingPUTPut /pipelines/{id}/resumeResume a pipeline execution
PipelineControllerApiSavePipelineUsingPOSTPost /pipelinesSave a pipeline definition
PipelineControllerApiStartUsingPOSTPost /pipelines/startInitiate a pipeline execution
PipelineControllerApiUpdatePipelineUsingPUTPut /pipelines/{id}Update a pipeline definition
PipelineControllerApiUpdateStageUsingPATCHPatch /pipelines/{id}/stages/{stageId}Update a stage execution
PipelineTemplatesControllerApiCreateUsingPOSTPost /pipelineTemplatesCreate a pipeline template.
PipelineTemplatesControllerApiDeleteUsingDELETEDelete /pipelineTemplates/{id}Delete a pipeline template.
PipelineTemplatesControllerApiGetUsingGETGet /pipelineTemplates/{id}Get a pipeline template.
PipelineTemplatesControllerApiListPipelineTemplateDependentsUsingGETGet /pipelineTemplates/{id}/dependentsList all pipelines that implement a pipeline template
PipelineTemplatesControllerApiListUsingGETGet /pipelineTemplatesList pipeline templates.
PipelineTemplatesControllerApiResolveTemplatesUsingGETGet /pipelineTemplates/resolveResolve a pipeline template.
PipelineTemplatesControllerApiUpdateUsingPOSTPost /pipelineTemplates/{id}Update a pipeline template.
ProjectControllerApiAllPipelinesForProjectUsingGETGet /projects/{id}/pipelinesGet all pipelines for project
PubsubSubscriptionControllerApiAllUsingGET3Get /pubsub/subscriptionsRetrieve the list of pub/sub subscriptions configured in Echo.
SearchControllerApiSearchUsingGETGet /searchSearch infrastructure
SecurityGroupControllerApiAllByAccountUsingGET1Get /securityGroups/{account}Retrieve a list of security groups for a given account, grouped by region
SecurityGroupControllerApiAllUsingGET4Get /securityGroupsRetrieve a list of security groups, grouped by account, cloud provider, and region
SecurityGroupControllerApiGetSecurityGroupUsingGET1Get /securityGroups/{account}/{region}/{name}Retrieve a security group's details
ServerGroupControllerApiGetServerGroupDetailsUsingGETGet /applications/{applicationName}/serverGroups/{account}/{region}/{serverGroupName}Retrieve a server group's details
ServerGroupControllerApiGetServerGroupsForApplicationUsingGETGet /applications/{applicationName}/serverGroupsRetrieve a list of server groups for a given application
ServerGroupManagerControllerApiGetServerGroupManagersForApplicationUsingGETGet /applications/{application}/serverGroupManagersRetrieve a list of server group managers for an application
SnapshotControllerApiGetCurrentSnapshotUsingGETGet /applications/{application}/snapshots/{account}Get current snapshot
SnapshotControllerApiGetSnapshotHistoryUsingGETGet /applications/{application}/snapshots/{account}/historyGet snapshot history
SubnetControllerApiAllByCloudProviderUsingGET1Get /subnets/{cloudProvider}Retrieve a list of subnets for a given cloud provider
TaskControllerApiCancelTaskUsingPUT1Put /tasks/{id}/cancelCancel task
TaskControllerApiCancelTasksUsingPUTPut /tasks/cancelCancel tasks
TaskControllerApiDeleteTaskUsingDELETEDelete /tasks/{id}Delete task
TaskControllerApiGetTaskDetailsUsingGET1Get /tasks/{id}/details/{taskDetailsId}Get task details
TaskControllerApiGetTaskUsingGET1Get /tasks/{id}Get task
TaskControllerApiTaskUsingPOST1Post /tasksCreate task
V2PipelineTemplatesControllerApiCreateUsingPOST1Post /v2/pipelineTemplatesCreate a pipeline template.
V2PipelineTemplatesControllerApiDeleteUsingDELETE1Delete /v2/pipelineTemplates/{id}Delete a pipeline template.
V2PipelineTemplatesControllerApiGetUsingGET1Get /v2/pipelineTemplates/{id}Get a pipeline template.
V2PipelineTemplatesControllerApiListPipelineTemplateDependentsUsingGET1Get /v2/pipelineTemplates/{id}/dependentsList all pipelines that implement a pipeline template
V2PipelineTemplatesControllerApiListUsingGET1Get /v2/pipelineTemplatesList pipeline templates.
V2PipelineTemplatesControllerApiPlanUsingPOSTPost /v2/pipelineTemplates/planPlan a pipeline template configuration.
V2PipelineTemplatesControllerApiUpdateUsingPOST1Post /v2/pipelineTemplates/{id}Update a pipeline template.
VersionControllerApiGetVersionUsingGETGet /versionFetch Gate's current version
WebhookControllerApiPreconfiguredWebhooksUsingGETGet /webhooks/preconfiguredRetrieve a list of preconfigured webhooks in Orca
WebhookControllerApiWebhooksUsingPOSTPost /webhooks/{type}/{source}Endpoint for posting webhooks to Spinnaker's webhook service

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.

# Structs

No description provided by the author
No description provided by the author
APIClient manages communication with the Spinnaker API API v1.0.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth .
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author