titanclient

package module
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: Jan 13, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README

Titan Go Client

This project publishes a go client for Titan Server. It is entirely autogenerated from the OpenAPI specification. Do not edit files directly, see the Developing section for more info.

Contributing

This project follows the Titan community best practices:

It is maintained by the Titan community maintainers

For more information on how it works, and how to build and release new versions, see the Development Guidelines.

License

This is code is licensed under the Apache License 2.0. Full license is available here.

Documentation

Index

Constants

This section is empty.

Variables

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

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

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

	// 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 {
	CommitsApi *CommitsApiService

	ContextsApi *ContextsApiService

	OperationsApi *OperationsApiService

	RemotesApi *RemotesApiService

	RepositoriesApi *RepositoriesApiService

	VolumesApi *VolumesApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Titan API API v0.3.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

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

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

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

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

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

type APIResponse 

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

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

type ApiError 

type ApiError struct {
	// Unique code for the error
	Code string `json:"code,omitempty"`
	// Human readable description of the error
	Message string `json:"message"`
	// Additional details, such as server-side stack trace
	Details string `json:"details,omitempty"`
}

ApiError struct for ApiError

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 Commit 

type Commit struct {
	// Commit identifier
	Id string `json:"id"`
	// Additional commit metadata
	Properties map[string]interface{} `json:"properties"`
}

Commit struct for Commit

type CommitStatus 

type CommitStatus struct {
	// Logical size of data referenced by commit
	LogicalSize int64 `json:"logicalSize"`
	// Actual size of data referenced by commit
	ActualSize int64 `json:"actualSize"`
	// Amount of data uniquely held by this commit
	UniqueSize int64 `json:"uniqueSize"`
	// Whether this commit can be used as the source of an operation or whether it's still being created
	Ready bool `json:"ready"`
	// If commit failed to be created, error string explaining why
	Error string `json:"error,omitempty"`
}

CommitStatus struct for CommitStatus

type CommitsApiService 

type CommitsApiService service

CommitsApiService CommitsApi service

func (*CommitsApiService) CheckoutCommit 

func (a *CommitsApiService) CheckoutCommit(ctx _context.Context, repositoryName string, commitId string) (*_nethttp.Response, error)

CheckoutCommit Checkout the given commit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param commitId Commit identifier

func (*CommitsApiService) CreateCommit 

func (a *CommitsApiService) CreateCommit(ctx _context.Context, repositoryName string, commit Commit) (Commit, *_nethttp.Response, error)

CreateCommit Create new commit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param commit New commit to create

@return Commit

func (*CommitsApiService) DeleteCommit 

func (a *CommitsApiService) DeleteCommit(ctx _context.Context, repositoryName string, commitId string) (*_nethttp.Response, error)

DeleteCommit Discard a past commit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param commitId Commit identifier

func (*CommitsApiService) GetCommit 

func (a *CommitsApiService) GetCommit(ctx _context.Context, repositoryName string, commitId string) (Commit, *_nethttp.Response, error)

GetCommit Get information for a specific commit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param commitId Commit identifier

@return Commit

func (*CommitsApiService) GetCommitStatus 

func (a *CommitsApiService) GetCommitStatus(ctx _context.Context, repositoryName string, commitId string) (CommitStatus, *_nethttp.Response, error)

GetCommitStatus Get commit status

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param commitId Commit identifier

@return CommitStatus

func (*CommitsApiService) ListCommits 

func (a *CommitsApiService) ListCommits(ctx _context.Context, repositoryName string, localVarOptionals *ListCommitsOpts) ([]Commit, *_nethttp.Response, error)

ListCommits Get commit history for a repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param optional nil or *ListCommitsOpts - Optional Parameters:
  • @param "Tag" (optional.Interface of []string) - Tags (name or name=value) to search for

@return []Commit

func (*CommitsApiService) UpdateCommit 

func (a *CommitsApiService) UpdateCommit(ctx _context.Context, repositoryName string, commitId string, commit Commit) (Commit, *_nethttp.Response, error)

UpdateCommit Update tags for a previous commit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param commitId Commit identifier
  • @param commit Commit contents to update

@return Commit

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"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

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

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

func (*Configuration) ServerUrl 

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

ServerUrl returns URL based on server settings

type Context 

type Context struct {
	// Provider type
	Provider string `json:"provider"`
	// Additional provider-specific configuration
	Properties map[string]interface{} `json:"properties"`
}

Context struct for Context

type ContextsApiService 

type ContextsApiService service

ContextsApiService ContextsApi service

func (*ContextsApiService) GetContext 

func (a *ContextsApiService) GetContext(ctx _context.Context) (Context, *_nethttp.Response, error)

GetContext Get current context

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

@return Context

type GenericOpenAPIError 

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

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

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

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

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetOperationProgressOpts 

type GetOperationProgressOpts struct {
	LastId optional.Int32
}

GetOperationProgressOpts Optional parameters for the method 'GetOperationProgress'

type ListCommitsOpts 

type ListCommitsOpts struct {
	Tag optional.Interface
}

ListCommitsOpts Optional parameters for the method 'ListCommits'

type ListOperationsOpts 

type ListOperationsOpts struct {
	Repository optional.String
}

ListOperationsOpts Optional parameters for the method 'ListOperations'

type ListRemoteCommitsOpts 

type ListRemoteCommitsOpts struct {
	Tag optional.Interface
}

ListRemoteCommitsOpts Optional parameters for the method 'ListRemoteCommits'

type Operation 

type Operation struct {
	// Unique identifier for the operation
	Id string `json:"id"`
	// Operation type
	Type string `json:"type"`
	// Current operation state
	State string `json:"state"`
	// Name of remote associated with the operation
	Remote string `json:"remote"`
	// Commit identifier being pushed or pulled
	CommitId string `json:"commitId"`
}

Operation struct for Operation

type OperationsApiService 

type OperationsApiService service

OperationsApiService OperationsApi service

func (*OperationsApiService) AbortOperation 

func (a *OperationsApiService) AbortOperation(ctx _context.Context, operationId string) (*_nethttp.Response, error)

AbortOperation Abort operation

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

func (*OperationsApiService) GetOperation 

func (a *OperationsApiService) GetOperation(ctx _context.Context, operationId string) (Operation, *_nethttp.Response, error)

GetOperation Get operation

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

@return Operation

func (*OperationsApiService) GetOperationProgress 

func (a *OperationsApiService) GetOperationProgress(ctx _context.Context, operationId string, localVarOptionals *GetOperationProgressOpts) ([]ProgressEntry, *_nethttp.Response, error)

GetOperationProgress Get operation progress

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param operationId Operation identifier
  • @param optional nil or *GetOperationProgressOpts - Optional Parameters:
  • @param "LastId" (optional.Int32) -

@return []ProgressEntry

func (*OperationsApiService) ListOperations 

func (a *OperationsApiService) ListOperations(ctx _context.Context, localVarOptionals *ListOperationsOpts) ([]Operation, *_nethttp.Response, error)

ListOperations List operations

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ListOperationsOpts - Optional Parameters:
  • @param "Repository" (optional.String) - Limit to the given repository

@return []Operation

func (*OperationsApiService) Pull 

func (a *OperationsApiService) Pull(ctx _context.Context, repositoryName string, remoteName string, commitId string, remoteParameters RemoteParameters, localVarOptionals *PullOpts) (Operation, *_nethttp.Response, error)

Pull Start a pull operation

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote
  • @param commitId Commit identifier
  • @param remoteParameters Provider specific parameters
  • @param optional nil or *PullOpts - Optional Parameters:
  • @param "MetadataOnly" (optional.Bool) - Transfer only tag metadata

@return Operation

func (*OperationsApiService) Push 

func (a *OperationsApiService) Push(ctx _context.Context, repositoryName string, remoteName string, commitId string, remoteParameters RemoteParameters, localVarOptionals *PushOpts) (Operation, *_nethttp.Response, error)

Push Start a push operation

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote
  • @param commitId Commit identifier
  • @param remoteParameters Provider specific parameters
  • @param optional nil or *PushOpts - Optional Parameters:
  • @param "MetadataOnly" (optional.Bool) - Transfer only tag metadata

@return Operation

type ProgressEntry 

type ProgressEntry struct {
	// Sequenced entry identifier
	Id int32 `json:"id"`
	// Entry type
	Type string `json:"type"`
	// Optional message for progress step
	Message string `json:"message,omitempty"`
	// Optional percent for step
	Percent int32 `json:"percent,omitempty"`
}

ProgressEntry struct for ProgressEntry

type PullOpts 

type PullOpts struct {
	MetadataOnly optional.Bool
}

PullOpts Optional parameters for the method 'Pull'

type PushOpts 

type PushOpts struct {
	MetadataOnly optional.Bool
}

PushOpts Optional parameters for the method 'Push'

type Remote 

type Remote struct {
	// Remote type
	Provider string `json:"provider"`
	// Name of remote
	Name string `json:"name"`
	// Provider-specific remote properties
	Properties map[string]interface{} `json:"properties"`
}

Remote struct for Remote

type RemoteParameters 

type RemoteParameters struct {
	// Remote type
	Provider string `json:"provider"`
	// Provider-specific remote properties
	Properties map[string]interface{} `json:"properties"`
}

RemoteParameters struct for RemoteParameters

type RemotesApiService 

type RemotesApiService service

RemotesApiService RemotesApi service

func (*RemotesApiService) CreateRemote 

func (a *RemotesApiService) CreateRemote(ctx _context.Context, repositoryName string, remote Remote) (Remote, *_nethttp.Response, error)

CreateRemote Create new remote

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remote Remote to create

@return Remote

func (*RemotesApiService) DeleteRemote 

func (a *RemotesApiService) DeleteRemote(ctx _context.Context, repositoryName string, remoteName string) (*_nethttp.Response, error)

DeleteRemote Delete remote

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote

func (*RemotesApiService) GetRemote 

func (a *RemotesApiService) GetRemote(ctx _context.Context, repositoryName string, remoteName string) (Remote, *_nethttp.Response, error)

GetRemote Get information about a particular remote

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote

@return Remote

func (*RemotesApiService) GetRemoteCommit 

func (a *RemotesApiService) GetRemoteCommit(ctx _context.Context, repositoryName string, remoteName string, commitId string, titanRemoteParameters RemoteParameters) (Commit, *_nethttp.Response, error)

GetRemoteCommit Get a remote commit

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote
  • @param commitId Commit identifier
  • @param titanRemoteParameters Remote-specific parameters

@return Commit

func (*RemotesApiService) ListRemoteCommits 

func (a *RemotesApiService) ListRemoteCommits(ctx _context.Context, repositoryName string, remoteName string, titanRemoteParameters RemoteParameters, localVarOptionals *ListRemoteCommitsOpts) ([]Commit, *_nethttp.Response, error)

ListRemoteCommits List remote commits

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote
  • @param titanRemoteParameters Remote-specific parameters
  • @param optional nil or *ListRemoteCommitsOpts - Optional Parameters:
  • @param "Tag" (optional.Interface of []string) - Tags (name or name=value) to search for

@return []Commit

func (*RemotesApiService) ListRemotes 

func (a *RemotesApiService) ListRemotes(ctx _context.Context, repositoryName string) ([]Remote, *_nethttp.Response, error)

ListRemotes Get list of remotes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository

@return []Remote

func (*RemotesApiService) UpdateRemote 

func (a *RemotesApiService) UpdateRemote(ctx _context.Context, repositoryName string, remoteName string, remote Remote) (Remote, *_nethttp.Response, error)

UpdateRemote Update remote information

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param remoteName Name of the remote
  • @param remote Remote information to update

@return Remote

type RepositoriesApiService 

type RepositoriesApiService service

RepositoriesApiService RepositoriesApi service

func (*RepositoriesApiService) CreateRepository 

func (a *RepositoriesApiService) CreateRepository(ctx _context.Context, repository Repository) (Repository, *_nethttp.Response, error)

CreateRepository Create new repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repository New repository to create

@return Repository

func (*RepositoriesApiService) DeleteRepository 

func (a *RepositoriesApiService) DeleteRepository(ctx _context.Context, repositoryName string) (*_nethttp.Response, error)

DeleteRepository Remove a repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository

func (*RepositoriesApiService) GetRepository 

func (a *RepositoriesApiService) GetRepository(ctx _context.Context, repositoryName string) (Repository, *_nethttp.Response, error)

GetRepository Get info for a repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository

@return Repository

func (*RepositoriesApiService) GetRepositoryStatus 

func (a *RepositoriesApiService) GetRepositoryStatus(ctx _context.Context, repositoryName string) (RepositoryStatus, *_nethttp.Response, error)

GetRepositoryStatus Get current status of a repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository

@return RepositoryStatus

func (*RepositoriesApiService) ListRepositories 

func (a *RepositoriesApiService) ListRepositories(ctx _context.Context) ([]Repository, *_nethttp.Response, error)

ListRepositories List repositories

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

@return []Repository

func (*RepositoriesApiService) UpdateRepository 

func (a *RepositoriesApiService) UpdateRepository(ctx _context.Context, repositoryName string, repository Repository) (Repository, *_nethttp.Response, error)

UpdateRepository Update or rename a repository

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param repository New repository

@return Repository

type Repository 

type Repository struct {
	// Repository name
	Name string `json:"name"`
	// Client-specific properties
	Properties map[string]interface{} `json:"properties"`
}

Repository struct for Repository

type RepositoryStatus 

type RepositoryStatus struct {
	// The latest commit ID for the repository
	LastCommit string `json:"lastCommit,omitempty"`
	// The source commit for the current state (last checkout or commit)
	SourceCommit string `json:"sourceCommit,omitempty"`
}

RepositoryStatus struct for RepositoryStatus

type ServerConfiguration 

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

ServerConfiguration stores the information about a server

type ServerVariable 

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

ServerVariable stores the information about a server variable

type Volume 

type Volume struct {
	// Volume name
	Name string `json:"name"`
	// Client-specific properties
	Properties map[string]interface{} `json:"properties"`
	// Server-generated configuration
	Config map[string]interface{} `json:"config,omitempty"`
}

Volume struct for Volume

type VolumeStatus 

type VolumeStatus struct {
	// Volume name
	Name string `json:"name"`
	// Logical size consumed by the volume
	LogicalSize int64 `json:"logicalSize"`
	// Actual (compressed) size used by the volume
	ActualSize int64 `json:"actualSize"`
	// Client-specific properties
	Properties map[string]interface{} `json:"properties"`
	// True if the volume is ready for use in a runtime environmemnt
	Ready bool `json:"ready"`
	// Optional error message if volume asynchronously failed to be created
	Error string `json:"error,omitempty"`
}

VolumeStatus struct for VolumeStatus

type VolumesApiService 

type VolumesApiService service

VolumesApiService VolumesApi service

func (*VolumesApiService) ActivateVolume 

func (a *VolumesApiService) ActivateVolume(ctx _context.Context, repositoryName string, volumeName string) (*_nethttp.Response, error)

ActivateVolume Activate a volume for use by a repository (e.g. mount)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param volumeName Name of the volume

func (*VolumesApiService) CreateVolume 

func (a *VolumesApiService) CreateVolume(ctx _context.Context, repositoryName string, volume Volume) (Volume, *_nethttp.Response, error)

CreateVolume Create new volume

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param volume New volume to create

@return Volume

func (*VolumesApiService) DeactivateVolume 

func (a *VolumesApiService) DeactivateVolume(ctx _context.Context, repositoryName string, volumeName string) (*_nethttp.Response, error)

DeactivateVolume Deactivate a volume prior to its deletion (e.g. unmount)

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param volumeName Name of the volume

func (*VolumesApiService) DeleteVolume 

func (a *VolumesApiService) DeleteVolume(ctx _context.Context, repositoryName string, volumeName string) (*_nethttp.Response, error)

DeleteVolume Remove a volume

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param volumeName Name of the volume

func (*VolumesApiService) GetVolume 

func (a *VolumesApiService) GetVolume(ctx _context.Context, repositoryName string, volumeName string) (Volume, *_nethttp.Response, error)

GetVolume Get info for a volume

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param volumeName Name of the volume

@return Volume

func (*VolumesApiService) GetVolumeStatus 

func (a *VolumesApiService) GetVolumeStatus(ctx _context.Context, repositoryName string, volumeName string) (VolumeStatus, *_nethttp.Response, error)

GetVolumeStatus Get status of a volume

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository
  • @param volumeName Name of the volume

@return VolumeStatus

func (*VolumesApiService) ListVolumes 

func (a *VolumesApiService) ListVolumes(ctx _context.Context, repositoryName string) ([]Volume, *_nethttp.Response, error)

ListVolumes List volumes

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param repositoryName Name of the repository

@return []Volume

Source Files

View all Source files

Jump to

Keyboard shortcuts

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