Documentation
¶
Index ¶
- type API
- func (*API) Close()
- func (a *API) CreateArtifactRoot(ctx context.Context, request *CreateArtifactRootRequest) (*CreateArtifactRootResponse, error)
- func (a *API) CreateArtifactSource(ctx context.Context, request *CreateArtifactSourceRequest) (*CreateArtifactSourceResponse, error)
- func (a *API) GetArtifactRoot(ctx context.Context, request *GetArtifactRootRequest) (*GetArtifactRootResponse, error)
- func (a *API) GetArtifactSource(ctx context.Context, request *GetArtifactSourceRequest) (*GetArtifactSourceResponse, error)
- func (a *API) GetManagedSourceState(ctx context.Context, request *GetManagedSourceStateRequest) (*GetManagedSourceStateResponse, error)
- func (a *API) ListArtifactRoots(ctx context.Context, _ *ListArtifactRootsRequest) (*ListArtifactRootsResponse, error)
- func (a *API) ListArtifactSourceKinds(ctx context.Context, _ *ListArtifactSourceKindsRequest) (*ListArtifactSourceKindsResponse, error)
- func (a *API) ListArtifactSources(ctx context.Context, request *ListArtifactSourcesRequest) (*ListArtifactSourcesResponse, error)
- func (a *API) PublishManagedSourcePackage(ctx context.Context, request *PublishManagedSourcePackageRequest) (*PublishManagedSourcePackageResponse, error)
- func (a *API) PurgeArtifactRoot(ctx context.Context, request *PurgeArtifactRootRequest) (*PurgeArtifactRootResponse, error)
- func (a *API) PurgeArtifactSource(ctx context.Context, request *PurgeArtifactSourceRequest) (*PurgeArtifactSourceResponse, error)
- func (a *API) RemoveManagedSourcePackage(ctx context.Context, request *RemoveManagedSourcePackageRequest) (*RemoveManagedSourcePackageResponse, error)
- func (a *API) RetireArtifactRoot(ctx context.Context, request *RetireArtifactRootRequest) (*RetireArtifactRootResponse, error)
- func (a *API) RetireArtifactSource(ctx context.Context, request *RetireArtifactSourceRequest) (*RetireArtifactSourceResponse, error)
- func (a *API) UpdateArtifactRoot(ctx context.Context, request *UpdateArtifactRootRequest) (*UpdateArtifactRootResponse, error)
- func (a *API) UpdateArtifactSource(ctx context.Context, request *UpdateArtifactSourceRequest) (*UpdateArtifactSourceResponse, error)
- type ArtifactSourceDraft
- type CreateArtifactRootRequest
- type CreateArtifactRootResponse
- type CreateArtifactSourceRequest
- type CreateArtifactSourceResponse
- type GetArtifactRootRequest
- type GetArtifactRootResponse
- type GetArtifactSourceRequest
- type GetArtifactSourceResponse
- type GetManagedSourceStateRequest
- type GetManagedSourceStateResponse
- type GetManagedSourceStateResponseBody
- type ListArtifactRootsRequest
- type ListArtifactRootsResponse
- type ListArtifactRootsResponseBody
- type ListArtifactSourceKindsRequest
- type ListArtifactSourceKindsResponse
- type ListArtifactSourceKindsResponseBody
- type ListArtifactSourcesRequest
- type ListArtifactSourcesResponse
- type ListArtifactSourcesResponseBody
- type PublishManagedSourcePackageRequest
- type PublishManagedSourcePackageRequestBody
- type PublishManagedSourcePackageResponse
- type PublishManagedSourcePackageResponseBody
- type PurgeArtifactRootRequest
- type PurgeArtifactRootResponse
- type PurgeArtifactSourceRequest
- type PurgeArtifactSourceResponse
- type RemoveManagedSourcePackageRequest
- type RemoveManagedSourcePackageResponse
- type RemoveManagedSourcePackageResponseBody
- type RetireArtifactRootRequest
- type RetireArtifactRootResponse
- type RetireArtifactSourceRequest
- type RetireArtifactSourceResponse
- type UpdateArtifactRootRequest
- type UpdateArtifactRootResponse
- type UpdateArtifactSourceRequest
- type UpdateArtifactSourceRequestBody
- type UpdateArtifactSourceResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶ added in v0.2.13
type API struct {
// contains filtered or unexported fields
}
API provides the transport-independent Artifact Store API.
The caller owns the lifecycle of the supplied Components.
func (*API) Close ¶ added in v0.2.14
func (*API) Close()
Close exists for transport lifecycle symmetry. Components remain owned and closed by the application composition root.
func (*API) CreateArtifactRoot ¶ added in v0.2.13
func (a *API) CreateArtifactRoot( ctx context.Context, request *CreateArtifactRootRequest, ) (*CreateArtifactRootResponse, error)
func (*API) CreateArtifactSource ¶ added in v0.2.13
func (a *API) CreateArtifactSource( ctx context.Context, request *CreateArtifactSourceRequest, ) (*CreateArtifactSourceResponse, error)
func (*API) GetArtifactRoot ¶ added in v0.2.13
func (a *API) GetArtifactRoot( ctx context.Context, request *GetArtifactRootRequest, ) (*GetArtifactRootResponse, error)
func (*API) GetArtifactSource ¶ added in v0.2.13
func (a *API) GetArtifactSource( ctx context.Context, request *GetArtifactSourceRequest, ) (*GetArtifactSourceResponse, error)
func (*API) GetManagedSourceState ¶ added in v0.2.13
func (a *API) GetManagedSourceState( ctx context.Context, request *GetManagedSourceStateRequest, ) (*GetManagedSourceStateResponse, error)
func (*API) ListArtifactRoots ¶ added in v0.2.13
func (a *API) ListArtifactRoots( ctx context.Context, _ *ListArtifactRootsRequest, ) (*ListArtifactRootsResponse, error)
func (*API) ListArtifactSourceKinds ¶ added in v0.2.13
func (a *API) ListArtifactSourceKinds( ctx context.Context, _ *ListArtifactSourceKindsRequest, ) (*ListArtifactSourceKindsResponse, error)
func (*API) ListArtifactSources ¶ added in v0.2.13
func (a *API) ListArtifactSources( ctx context.Context, request *ListArtifactSourcesRequest, ) (*ListArtifactSourcesResponse, error)
func (*API) PublishManagedSourcePackage ¶ added in v0.2.13
func (a *API) PublishManagedSourcePackage( ctx context.Context, request *PublishManagedSourcePackageRequest, ) (*PublishManagedSourcePackageResponse, error)
func (*API) PurgeArtifactRoot ¶ added in v0.2.13
func (a *API) PurgeArtifactRoot( ctx context.Context, request *PurgeArtifactRootRequest, ) (*PurgeArtifactRootResponse, error)
func (*API) PurgeArtifactSource ¶ added in v0.2.13
func (a *API) PurgeArtifactSource( ctx context.Context, request *PurgeArtifactSourceRequest, ) (*PurgeArtifactSourceResponse, error)
func (*API) RemoveManagedSourcePackage ¶ added in v0.2.13
func (a *API) RemoveManagedSourcePackage( ctx context.Context, request *RemoveManagedSourcePackageRequest, ) (*RemoveManagedSourcePackageResponse, error)
func (*API) RetireArtifactRoot ¶ added in v0.2.13
func (a *API) RetireArtifactRoot( ctx context.Context, request *RetireArtifactRootRequest, ) (*RetireArtifactRootResponse, error)
func (*API) RetireArtifactSource ¶ added in v0.2.13
func (a *API) RetireArtifactSource( ctx context.Context, request *RetireArtifactSourceRequest, ) (*RetireArtifactSourceResponse, error)
func (*API) UpdateArtifactRoot ¶ added in v0.2.13
func (a *API) UpdateArtifactRoot( ctx context.Context, request *UpdateArtifactRootRequest, ) (*UpdateArtifactRootResponse, error)
func (*API) UpdateArtifactSource ¶ added in v0.2.13
func (a *API) UpdateArtifactSource( ctx context.Context, request *UpdateArtifactSourceRequest, ) (*UpdateArtifactSourceResponse, error)
type ArtifactSourceDraft ¶ added in v0.2.13
type ArtifactSourceDraft struct {
ID basespec.SourceID `json:"id" required:"true"`
StorageKey basespec.StorageKey `json:"storageKey" required:"true"`
Kind basespec.SourceKind `json:"kind" required:"true"`
DisplayName string `json:"displayName" required:"true"`
Enabled bool `json:"enabled"`
Config json.RawMessage `json:"config"`
}
ArtifactSourceDraft is write-only. Source configuration can contain local filesystem paths or provider credentials and is not returned by the API.
type CreateArtifactRootRequest ¶ added in v0.2.13
type CreateArtifactRootResponse ¶ added in v0.2.13
type CreateArtifactSourceRequest ¶ added in v0.2.13
type CreateArtifactSourceRequest struct {
RootID basespec.RootID `path:"rootID" required:"true"`
Body *ArtifactSourceDraft
}
type CreateArtifactSourceResponse ¶ added in v0.2.13
type GetArtifactRootRequest ¶ added in v0.2.13
type GetArtifactRootResponse ¶ added in v0.2.13
type GetArtifactSourceRequest ¶ added in v0.2.13
type GetArtifactSourceResponse ¶ added in v0.2.13
type GetManagedSourceStateRequest ¶ added in v0.2.13
type GetManagedSourceStateResponse ¶ added in v0.2.13
type GetManagedSourceStateResponse struct {
Body *GetManagedSourceStateResponseBody
}
type GetManagedSourceStateResponseBody ¶ added in v0.2.13
type ListArtifactRootsRequest ¶ added in v0.2.13
type ListArtifactRootsRequest struct{}
type ListArtifactRootsResponse ¶ added in v0.2.13
type ListArtifactRootsResponse struct {
Body *ListArtifactRootsResponseBody
}
type ListArtifactRootsResponseBody ¶ added in v0.2.13
type ListArtifactSourceKindsRequest ¶ added in v0.2.13
type ListArtifactSourceKindsRequest struct{}
type ListArtifactSourceKindsResponse ¶ added in v0.2.13
type ListArtifactSourceKindsResponse struct {
Body *ListArtifactSourceKindsResponseBody
}
type ListArtifactSourceKindsResponseBody ¶ added in v0.2.13
type ListArtifactSourceKindsResponseBody struct {
Kinds []basespec.SourceKind `json:"kinds"`
}
type ListArtifactSourcesRequest ¶ added in v0.2.13
type ListArtifactSourcesResponse ¶ added in v0.2.13
type ListArtifactSourcesResponse struct {
Body *ListArtifactSourcesResponseBody
}
type ListArtifactSourcesResponseBody ¶ added in v0.2.13
type PublishManagedSourcePackageRequest ¶ added in v0.2.13
type PublishManagedSourcePackageRequest struct {
RootID basespec.RootID `json:"rootID" required:"true"`
SourceID basespec.SourceID `json:"sourceID" required:"true"`
Body *PublishManagedSourcePackageRequestBody
}
type PublishManagedSourcePackageRequestBody ¶ added in v0.2.13
type PublishManagedSourcePackageRequestBody struct {
ExpectedSourceRevision uint64 `json:"expectedSourceRevision" required:"true"`
Address source.ManagedPackageAddress `json:"address" required:"true"`
ExpectedGeneration string `json:"expectedGeneration,omitempty"`
Files []source.ManagedPackageFile `json:"files" required:"true"`
}
type PublishManagedSourcePackageResponse ¶ added in v0.2.13
type PublishManagedSourcePackageResponse struct {
Body *PublishManagedSourcePackageResponseBody
}
type PublishManagedSourcePackageResponseBody ¶ added in v0.2.13
type PurgeArtifactRootRequest ¶ added in v0.2.13
type PurgeArtifactRootResponse ¶ added in v0.2.13
type PurgeArtifactSourceRequest ¶ added in v0.2.13
type PurgeArtifactSourceResponse ¶ added in v0.2.13
type RemoveManagedSourcePackageRequest ¶ added in v0.2.13
type RemoveManagedSourcePackageRequest struct {
RootID basespec.RootID `json:"rootID" required:"true"`
SourceID basespec.SourceID `json:"sourceID" required:"true"`
ExpectedSourceRevision uint64 `json:"expectedSourceRevision" required:"true"`
Address source.ManagedPackageAddress `json:"address" required:"true"`
ExpectedGeneration string `json:"expectedGeneration" required:"true"`
}
type RemoveManagedSourcePackageResponse ¶ added in v0.2.13
type RemoveManagedSourcePackageResponse struct {
Body *RemoveManagedSourcePackageResponseBody
}
type RemoveManagedSourcePackageResponseBody ¶ added in v0.2.13
type RetireArtifactRootRequest ¶ added in v0.2.13
type RetireArtifactRootResponse ¶ added in v0.2.13
type RetireArtifactSourceRequest ¶ added in v0.2.13
type RetireArtifactSourceResponse ¶ added in v0.2.13
type UpdateArtifactRootRequest ¶ added in v0.2.13
type UpdateArtifactRootRequest struct {
RootID basespec.RootID `path:"rootID" required:"true"`
Body *root.RootUpdate
}
type UpdateArtifactRootResponse ¶ added in v0.2.13
type UpdateArtifactSourceRequest ¶ added in v0.2.13
type UpdateArtifactSourceRequest struct {
RootID basespec.RootID `path:"rootID" required:"true"`
SourceID basespec.SourceID `path:"sourceID" required:"true"`
Body *UpdateArtifactSourceRequestBody
}
type UpdateArtifactSourceRequestBody ¶ added in v0.2.13
type UpdateArtifactSourceRequestBody struct {
ExpectedRevision uint64 `json:"expectedRevision" required:"true"`
DisplayName string `json:"displayName" required:"true"`
Enabled bool `json:"enabled"`
Config json.RawMessage `json:"config,omitempty"`
}
type UpdateArtifactSourceResponse ¶ added in v0.2.13
Click to show internal directories.
Click to hide internal directories.