# 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
Class | Method | HTTP request | Description |
---|---|---|---|
AmazonInfrastructureControllerApi | InstanceTypesUsingGET | Get /instanceTypes | Get instance types |
AmazonInfrastructureControllerApi | SubnetsUsingGET | Get /subnets | Get subnets |
AmazonInfrastructureControllerApi | VpcsUsingGET | Get /vpcs | Get VPCs |
ApplicationControllerApi | CancelPipelineUsingPUT | Put /applications/{application}/pipelines/{id}/cancel | Cancel pipeline |
ApplicationControllerApi | CancelTaskUsingPUT | Put /applications/{application}/tasks/{id}/cancel | Cancel task |
ApplicationControllerApi | GetAllApplicationsUsingGET | Get /applications | Retrieve a list of applications |
ApplicationControllerApi | GetApplicationHistoryUsingGET | Get /applications/{application}/history | Retrieve a list of an application's configuration revision history |
ApplicationControllerApi | GetApplicationUsingGET | Get /applications/{application} | Retrieve an application's details |
ApplicationControllerApi | GetPipelineConfigUsingGET | Get /applications/{application}/pipelineConfigs/{pipelineName} | Retrieve a pipeline configuration |
ApplicationControllerApi | GetPipelineConfigsForApplicationUsingGET | Get /applications/{application}/pipelineConfigs | Retrieve a list of an application's pipeline configurations |
ApplicationControllerApi | GetPipelinesUsingGET | Get /applications/{application}/pipelines | Retrieve a list of an application's pipeline executions |
ApplicationControllerApi | GetStrategyConfigUsingGET | Get /applications/{application}/strategyConfigs/{strategyName} | Retrieve a pipeline strategy configuration |
ApplicationControllerApi | GetStrategyConfigsForApplicationUsingGET | Get /applications/{application}/strategyConfigs | Retrieve a list of an application's pipeline strategy configurations |
ApplicationControllerApi | GetTaskDetailsUsingGET | Get /applications/{application}/tasks/{id}/details/{taskDetailsId} | Get task details |
ApplicationControllerApi | GetTaskUsingGET | Get /applications/{application}/tasks/{id} | Get task |
ApplicationControllerApi | GetTasksUsingGET | Get /applications/{application}/tasks | Retrieve a list of an application's tasks |
ApplicationControllerApi | InvokePipelineConfigUsingPOST | Post /applications/{application}/pipelineConfigs/{pipelineName} | Invoke pipeline config |
ApplicationControllerApi | TaskUsingPOST | Post /applications/{application}/tasks | Create task |
ArtifactControllerApi | AllUsingGET | Get /artifacts/credentials | Retrieve the list of artifact accounts configured in Clouddriver. |
AuditEventsMvcEndpointApi | FindByPrincipalAndAfterAndTypeUsingGET | Get /auditevents | findByPrincipalAndAfterAndType |
AuditEventsMvcEndpointApi | FindByPrincipalAndAfterAndTypeUsingGET1 | Get /auditevents.json | findByPrincipalAndAfterAndType |
AuthControllerApi | GetServiceAccountsUsingGET | Get /auth/user/serviceAccounts | Get service accounts |
AuthControllerApi | LoggedOutUsingGET | Get /auth/loggedOut | Get logged out message |
AuthControllerApi | RedirectUsingGET | Get /auth/redirect | Redirect to Deck |
AuthControllerApi | SyncUsingPOST | Post /auth/roles/sync | Sync user roles |
AuthControllerApi | UserUsingGET | Get /auth/user | Get user |
BakeControllerApi | BakeOptionsUsingGET | Get /bakery/options/{cloudProvider} | Retrieve a list of available bakery base images for a given cloud provider |
BakeControllerApi | BakeOptionsUsingGET1 | Get /bakery/options | Retrieve a list of available bakery base images, grouped by cloud provider |
BakeControllerApi | LookupLogsUsingGET | Get /bakery/logs/{region}/{statusId} | Retrieve the logs for a given bake |
BuildControllerApi | GetBuildMastersUsingGET | Get /v2/builds | Get build masters |
BuildControllerApi | GetBuildUsingGET | Get /v2/builds/{buildMaster}/build/{number}/** | Get build for build master |
BuildControllerApi | GetBuildsUsingGET | Get /v2/builds/{buildMaster}/builds/** | Get builds for build master |
BuildControllerApi | GetJobConfigUsingGET | Get /v2/builds/{buildMaster}/jobs/** | Get job config |
BuildControllerApi | GetJobsForBuildMasterUsingGET | Get /v2/builds/{buildMaster}/jobs | Get jobs for build master |
BuildControllerApi | V3GetBuildMastersUsingGET | Get /v3/builds | Get build masters |
BuildControllerApi | V3GetBuildUsingGET | Get /v3/builds/{buildMaster}/build/{number} | Get build for build master |
BuildControllerApi | V3GetBuildsUsingGET | Get /v3/builds/{buildMaster}/builds | Get builds for build master |
BuildControllerApi | V3GetJobConfigUsingGET | Get /v3/builds/{buildMaster}/job | Get job config |
BuildControllerApi | V3GetJobsForBuildMasterUsingGET | Get /v3/builds/{buildMaster}/jobs | Get jobs for build master |
ClusterControllerApi | GetClusterLoadBalancersUsingGET | Get /applications/{application}/clusters/{account}/{clusterName}/{type}/loadBalancers | Retrieve a cluster's loadbalancers |
ClusterControllerApi | GetClustersUsingGET | Get /applications/{application}/clusters/{account}/{clusterName} | Retrieve a cluster's details |
ClusterControllerApi | GetClustersUsingGET1 | Get /applications/{application}/clusters/{account} | Retrieve a list of clusters for an account |
ClusterControllerApi | GetClustersUsingGET2 | Get /applications/{application}/clusters | Retrieve a list of cluster names for an application, grouped by account |
ClusterControllerApi | GetScalingActivitiesUsingGET | Get /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}/scalingActivities | Retrieve a list of scaling activities for a server group |
ClusterControllerApi | GetServerGroupsUsingGET | Get /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName} | Retrieve a server group's details |
ClusterControllerApi | GetServerGroupsUsingGET1 | Get /applications/{application}/clusters/{account}/{clusterName}/serverGroups | Retrieve a list of server groups for a cluster |
ClusterControllerApi | GetTargetServerGroupUsingGET | Get /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 |
CredentialsControllerApi | GetAccountUsingGET | Get /credentials/{account} | Retrieve an account's details |
CredentialsControllerApi | GetAccountsUsingGET | Get /credentials | Retrieve a list of accounts |
EcsServerGroupEventsControllerApi | GetEventsUsingGET | Get /applications/{application}/serverGroups/{account}/{serverGroupName}/events | Retrieves a list of events for a server group |
ExecutionsControllerApi | GetLatestExecutionsByConfigIdsUsingGET | Get /executions | Retrieves 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. |
ExecutionsControllerApi | SearchForPipelineExecutionsByTriggerUsingGET | Get /applications/{application}/executions/search | Search 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. |
FirewallControllerApi | AllByAccountUsingGET | Get /firewalls/{account} | Retrieve a list of firewalls for a given account, grouped by region |
FirewallControllerApi | AllUsingGET1 | Get /firewalls | Retrieve a list of firewalls, grouped by account, cloud provider, and region |
FirewallControllerApi | GetSecurityGroupUsingGET | Get /firewalls/{account}/{region}/{name} | Retrieve a firewall's details |
ImageControllerApi | FindImagesUsingGET | Get /images/find | Retrieve a list of images, filtered by cloud provider, region, and account |
ImageControllerApi | FindTagsUsingGET | Get /images/tags | Find tags |
ImageControllerApi | GetImageDetailsUsingGET | Get /images/{account}/{region}/{imageId} | Get image details |
InstanceControllerApi | GetConsoleOutputUsingGET | Get /instances/{account}/{region}/{instanceId}/console | Retrieve an instance's console output |
InstanceControllerApi | GetInstanceDetailsUsingGET | Get /instances/{account}/{region}/{instanceId} | Retrieve an instance's details |
JobControllerApi | GetJobUsingGET | Get /applications/{applicationName}/jobs/{account}/{region}/{name} | Get job |
JobControllerApi | GetJobsUsingGET | Get /applications/{applicationName}/jobs | Get jobs |
LoadBalancerControllerApi | GetAllUsingGET | Get /loadBalancers | Retrieve a list of load balancers for a given cloud provider |
LoadBalancerControllerApi | GetApplicationLoadBalancersUsingGET | Get /applications/{application}/loadBalancers | Retrieve a list of load balancers for a given application |
LoadBalancerControllerApi | GetLoadBalancerDetailsUsingGET | Get /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 |
LoadBalancerControllerApi | GetLoadBalancerUsingGET | Get /loadBalancers/{name} | Retrieve a load balancer for a given cloud provider |
NetworkControllerApi | AllByCloudProviderUsingGET | Get /networks/{cloudProvider} | Retrieve a list of networks for a given cloud provider |
NetworkControllerApi | AllUsingGET2 | Get /networks | Retrieve a list of networks, grouped by cloud provider |
PipelineConfigControllerApi | ConvertPipelineConfigToPipelineTemplateUsingGET | Get /pipelineConfigs/{pipelineConfigId}/convertToTemplate | Convert a pipeline config to a pipeline template. |
PipelineConfigControllerApi | GetAllPipelineConfigsUsingGET | Get /pipelineConfigs | Get all pipeline configs. |
PipelineConfigControllerApi | GetPipelineConfigHistoryUsingGET | Get /pipelineConfigs/{pipelineConfigId}/history | Get pipeline config history. |
PipelineControllerApi | CancelPipelineUsingPUT1 | Put /pipelines/{id}/cancel | Cancel a pipeline execution |
PipelineControllerApi | DeletePipelineUsingDELETE | Delete /pipelines/{application}/{pipelineName} | Delete a pipeline definition |
PipelineControllerApi | DeletePipelineUsingDELETE1 | Delete /pipelines/{id} | Delete a pipeline execution |
PipelineControllerApi | EvaluateExpressionForExecutionUsingDELETE | Delete /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | EvaluateExpressionForExecutionUsingGET | Get /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | EvaluateExpressionForExecutionUsingHEAD | Head /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | EvaluateExpressionForExecutionUsingOPTIONS | Options /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | EvaluateExpressionForExecutionUsingPATCH | Patch /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | EvaluateExpressionForExecutionUsingPUT | Put /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | EvaluateExpressionForExecutionViaPOSTUsingPOST1 | Post /pipelines/{id}/evaluateExpression | Evaluate a pipeline expression using the provided execution as context |
PipelineControllerApi | GetPipelineLogsUsingGET | Get /pipelines/{id}/logs | Retrieve pipeline execution logs |
PipelineControllerApi | GetPipelineUsingGET | Get /pipelines/{id} | Retrieve a pipeline execution |
PipelineControllerApi | InvokePipelineConfigUsingPOST1 | Post /pipelines/{application}/{pipelineNameOrId} | Trigger a pipeline execution |
PipelineControllerApi | InvokePipelineConfigViaEchoUsingPOST | Post /pipelines/v2/{application}/{pipelineNameOrId} | Trigger a pipeline execution |
PipelineControllerApi | PausePipelineUsingPUT | Put /pipelines/{id}/pause | Pause a pipeline execution |
PipelineControllerApi | RenamePipelineUsingPOST | Post /pipelines/move | Rename a pipeline definition |
PipelineControllerApi | RestartStageUsingPUT | Put /pipelines/{id}/stages/{stageId}/restart | Restart a stage execution |
PipelineControllerApi | ResumePipelineUsingPUT | Put /pipelines/{id}/resume | Resume a pipeline execution |
PipelineControllerApi | SavePipelineUsingPOST | Post /pipelines | Save a pipeline definition |
PipelineControllerApi | StartUsingPOST | Post /pipelines/start | Initiate a pipeline execution |
PipelineControllerApi | UpdatePipelineUsingPUT | Put /pipelines/{id} | Update a pipeline definition |
PipelineControllerApi | UpdateStageUsingPATCH | Patch /pipelines/{id}/stages/{stageId} | Update a stage execution |
PipelineTemplatesControllerApi | CreateUsingPOST | Post /pipelineTemplates | Create a pipeline template. |
PipelineTemplatesControllerApi | DeleteUsingDELETE | Delete /pipelineTemplates/{id} | Delete a pipeline template. |
PipelineTemplatesControllerApi | GetUsingGET | Get /pipelineTemplates/{id} | Get a pipeline template. |
PipelineTemplatesControllerApi | ListPipelineTemplateDependentsUsingGET | Get /pipelineTemplates/{id}/dependents | List all pipelines that implement a pipeline template |
PipelineTemplatesControllerApi | ListUsingGET | Get /pipelineTemplates | List pipeline templates. |
PipelineTemplatesControllerApi | ResolveTemplatesUsingGET | Get /pipelineTemplates/resolve | Resolve a pipeline template. |
PipelineTemplatesControllerApi | UpdateUsingPOST | Post /pipelineTemplates/{id} | Update a pipeline template. |
ProjectControllerApi | AllPipelinesForProjectUsingGET | Get /projects/{id}/pipelines | Get all pipelines for project |
PubsubSubscriptionControllerApi | AllUsingGET3 | Get /pubsub/subscriptions | Retrieve the list of pub/sub subscriptions configured in Echo. |
SearchControllerApi | SearchUsingGET | Get /search | Search infrastructure |
SecurityGroupControllerApi | AllByAccountUsingGET1 | Get /securityGroups/{account} | Retrieve a list of security groups for a given account, grouped by region |
SecurityGroupControllerApi | AllUsingGET4 | Get /securityGroups | Retrieve a list of security groups, grouped by account, cloud provider, and region |
SecurityGroupControllerApi | GetSecurityGroupUsingGET1 | Get /securityGroups/{account}/{region}/{name} | Retrieve a security group's details |
ServerGroupControllerApi | GetServerGroupDetailsUsingGET | Get /applications/{applicationName}/serverGroups/{account}/{region}/{serverGroupName} | Retrieve a server group's details |
ServerGroupControllerApi | GetServerGroupsForApplicationUsingGET | Get /applications/{applicationName}/serverGroups | Retrieve a list of server groups for a given application |
ServerGroupManagerControllerApi | GetServerGroupManagersForApplicationUsingGET | Get /applications/{application}/serverGroupManagers | Retrieve a list of server group managers for an application |
SnapshotControllerApi | GetCurrentSnapshotUsingGET | Get /applications/{application}/snapshots/{account} | Get current snapshot |
SnapshotControllerApi | GetSnapshotHistoryUsingGET | Get /applications/{application}/snapshots/{account}/history | Get snapshot history |
SubnetControllerApi | AllByCloudProviderUsingGET1 | Get /subnets/{cloudProvider} | Retrieve a list of subnets for a given cloud provider |
TaskControllerApi | CancelTaskUsingPUT1 | Put /tasks/{id}/cancel | Cancel task |
TaskControllerApi | CancelTasksUsingPUT | Put /tasks/cancel | Cancel tasks |
TaskControllerApi | DeleteTaskUsingDELETE | Delete /tasks/{id} | Delete task |
TaskControllerApi | GetTaskDetailsUsingGET1 | Get /tasks/{id}/details/{taskDetailsId} | Get task details |
TaskControllerApi | GetTaskUsingGET1 | Get /tasks/{id} | Get task |
TaskControllerApi | TaskUsingPOST1 | Post /tasks | Create task |
V2PipelineTemplatesControllerApi | CreateUsingPOST1 | Post /v2/pipelineTemplates | Create a pipeline template. |
V2PipelineTemplatesControllerApi | DeleteUsingDELETE1 | Delete /v2/pipelineTemplates/{id} | Delete a pipeline template. |
V2PipelineTemplatesControllerApi | GetUsingGET1 | Get /v2/pipelineTemplates/{id} | Get a pipeline template. |
V2PipelineTemplatesControllerApi | ListPipelineTemplateDependentsUsingGET1 | Get /v2/pipelineTemplates/{id}/dependents | List all pipelines that implement a pipeline template |
V2PipelineTemplatesControllerApi | ListUsingGET1 | Get /v2/pipelineTemplates | List pipeline templates. |
V2PipelineTemplatesControllerApi | PlanUsingPOST | Post /v2/pipelineTemplates/plan | Plan a pipeline template configuration. |
V2PipelineTemplatesControllerApi | UpdateUsingPOST1 | Post /v2/pipelineTemplates/{id} | Update a pipeline template. |
VersionControllerApi | GetVersionUsingGET | Get /version | Fetch Gate's current version |
WebhookControllerApi | PreconfiguredWebhooksUsingGET | Get /webhooks/preconfigured | Retrieve a list of preconfigured webhooks in Orca |
WebhookControllerApi | WebhooksUsingPOST | Post /webhooks/{type}/{source} | Endpoint for posting webhooks to Spinnaker's webhook service |
Documentation For Models
- Account
- AccountDetails
- GrantedAuthority
- HashMapstringobject
- HttpEntity
- Mapstringstring
- PipelineTemplateDependent
- ResponseEntity
- User
- Version
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