Documentation
¶
Index ¶
- Constants
- type BuildArtifactResponseV1
- func (m *BuildArtifactResponseV1) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *BuildArtifactResponseV1) MarshalBinary() ([]byte, error)
- func (m *BuildArtifactResponseV1) UnmarshalBinary(b []byte) error
- func (m *BuildArtifactResponseV1) Validate(formats strfmt.Registry) error
- type Error
- type ProductListResponse
- type ProductReleaseResponseV1
- func (m *ProductReleaseResponseV1) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductReleaseResponseV1) MarshalBinary() ([]byte, error)
- func (m *ProductReleaseResponseV1) UnmarshalBinary(b []byte) error
- func (m *ProductReleaseResponseV1) Validate(formats strfmt.Registry) error
- type ProductReleasesResponseV1
- type ReleaseStatus
Constants ¶
View Source
const ( // BuildArtifactResponseV1ArchNr386 captures enum value "386" BuildArtifactResponseV1ArchNr386 string = "386" // BuildArtifactResponseV1ArchAarch64 captures enum value "aarch64" BuildArtifactResponseV1ArchAarch64 string = "aarch64" // BuildArtifactResponseV1ArchAll captures enum value "all" BuildArtifactResponseV1ArchAll string = "all" // BuildArtifactResponseV1ArchAmd64 captures enum value "amd64" BuildArtifactResponseV1ArchAmd64 string = "amd64" // BuildArtifactResponseV1ArchArm captures enum value "arm" BuildArtifactResponseV1ArchArm string = "arm" // BuildArtifactResponseV1ArchArm5 captures enum value "arm5" BuildArtifactResponseV1ArchArm5 string = "arm5" // BuildArtifactResponseV1ArchArm6 captures enum value "arm6" BuildArtifactResponseV1ArchArm6 string = "arm6" // BuildArtifactResponseV1ArchArm64 captures enum value "arm64" BuildArtifactResponseV1ArchArm64 string = "arm64" // BuildArtifactResponseV1ArchArm7 captures enum value "arm7" BuildArtifactResponseV1ArchArm7 string = "arm7" // BuildArtifactResponseV1ArchArmelv5 captures enum value "armelv5" BuildArtifactResponseV1ArchArmelv5 string = "armelv5" // BuildArtifactResponseV1ArchArmhf captures enum value "armhf" BuildArtifactResponseV1ArchArmhf string = "armhf" // BuildArtifactResponseV1ArchArmhfv6 captures enum value "armhfv6" BuildArtifactResponseV1ArchArmhfv6 string = "armhfv6" // BuildArtifactResponseV1ArchI386 captures enum value "i386" BuildArtifactResponseV1ArchI386 string = "i386" // BuildArtifactResponseV1ArchI686 captures enum value "i686" BuildArtifactResponseV1ArchI686 string = "i686" // BuildArtifactResponseV1ArchMips captures enum value "mips" BuildArtifactResponseV1ArchMips string = "mips" // BuildArtifactResponseV1ArchMips64 captures enum value "mips64" BuildArtifactResponseV1ArchMips64 string = "mips64" // BuildArtifactResponseV1ArchMipsle captures enum value "mipsle" BuildArtifactResponseV1ArchMipsle string = "mipsle" // BuildArtifactResponseV1ArchPpc64le captures enum value "ppc64le" BuildArtifactResponseV1ArchPpc64le string = "ppc64le" // BuildArtifactResponseV1ArchS390x captures enum value "s390x" BuildArtifactResponseV1ArchS390x string = "s390x" // BuildArtifactResponseV1ArchUI captures enum value "ui" BuildArtifactResponseV1ArchUI string = "ui" // BuildArtifactResponseV1ArchX8664 captures enum value "x86_64" BuildArtifactResponseV1ArchX8664 string = "x86_64" )
View Source
const ( // BuildArtifactResponseV1OsArchlinux captures enum value "archlinux" BuildArtifactResponseV1OsArchlinux string = "archlinux" // BuildArtifactResponseV1OsCentos captures enum value "centos" BuildArtifactResponseV1OsCentos string = "centos" // BuildArtifactResponseV1OsDarwin captures enum value "darwin" BuildArtifactResponseV1OsDarwin string = "darwin" // BuildArtifactResponseV1OsDebian captures enum value "debian" BuildArtifactResponseV1OsDebian string = "debian" // BuildArtifactResponseV1OsDragonfly captures enum value "dragonfly" BuildArtifactResponseV1OsDragonfly string = "dragonfly" // BuildArtifactResponseV1OsFreebsd captures enum value "freebsd" BuildArtifactResponseV1OsFreebsd string = "freebsd" // BuildArtifactResponseV1OsLinux captures enum value "linux" BuildArtifactResponseV1OsLinux string = "linux" // BuildArtifactResponseV1OsNetbsd captures enum value "netbsd" BuildArtifactResponseV1OsNetbsd string = "netbsd" // BuildArtifactResponseV1OsOpenbsd captures enum value "openbsd" BuildArtifactResponseV1OsOpenbsd string = "openbsd" // BuildArtifactResponseV1OsPlan9 captures enum value "plan9" BuildArtifactResponseV1OsPlan9 string = "plan9" // BuildArtifactResponseV1OsPython captures enum value "python" BuildArtifactResponseV1OsPython string = "python" // BuildArtifactResponseV1OsSolaris captures enum value "solaris" BuildArtifactResponseV1OsSolaris string = "solaris" // BuildArtifactResponseV1OsTerraform captures enum value "terraform" BuildArtifactResponseV1OsTerraform string = "terraform" // BuildArtifactResponseV1OsWeb captures enum value "web" BuildArtifactResponseV1OsWeb string = "web" // BuildArtifactResponseV1OsWindows captures enum value "windows" BuildArtifactResponseV1OsWindows string = "windows" )
View Source
const ( // ProductReleaseResponseV1LicenseClassEnterprise captures enum value "enterprise" ProductReleaseResponseV1LicenseClassEnterprise string = "enterprise" // ProductReleaseResponseV1LicenseClassHcp captures enum value "hcp" ProductReleaseResponseV1LicenseClassHcp string = "hcp" // ProductReleaseResponseV1LicenseClassOss captures enum value "oss" ProductReleaseResponseV1LicenseClassOss string = "oss" )
View Source
const ( // ReleaseStatusStateSupported captures enum value "supported" ReleaseStatusStateSupported string = "supported" // ReleaseStatusStateUnsupported captures enum value "unsupported" ReleaseStatusStateUnsupported string = "unsupported" // ReleaseStatusStateWithdrawn captures enum value "withdrawn" ReleaseStatusStateWithdrawn string = "withdrawn" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildArtifactResponseV1 ¶
type BuildArtifactResponseV1 struct {
// The target architecture for this build
// Example: amd64
// Enum: [386 aarch64 all amd64 arm arm5 arm6 arm64 arm7 armelv5 armhf armhfv6 i386 i686 mips mips64 mipsle ppc64le s390x ui x86_64]
Arch string `json:"arch,omitempty"`
// The target operating system for this build
// Example: darwin
// Enum: [archlinux centos darwin debian dragonfly freebsd linux netbsd openbsd plan9 python solaris terraform web windows]
Os string `json:"os,omitempty"`
// True if this build is not supported by HashiCorp. Some os/arch combinations are built
// by HashiCorp for customer convenience but not officially supported.
//
// Example: false
Unsupported bool `json:"unsupported,omitempty"`
// The URL where this build can be downloaded
// Example: https://releases.hashicorp.com/consul/1.10.0+ent/consul_1.10.0+ent_darwin_amd64.zip
URL string `json:"url,omitempty"`
}
BuildArtifactResponseV1 Metadata for a single build within a product release
swagger:model build_artifact_response_v1
func (*BuildArtifactResponseV1) ContextValidate ¶
func (m *BuildArtifactResponseV1) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this build artifact response v1 based on context it is used
func (*BuildArtifactResponseV1) MarshalBinary ¶
func (m *BuildArtifactResponseV1) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildArtifactResponseV1) UnmarshalBinary ¶
func (m *BuildArtifactResponseV1) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// Error code uniquely identifying this error
// Required: true
Code *int64 `json:"code"`
// What went wrong
// Required: true
Message *string `json:"message"`
}
Error Error code and message to uniquely identify error. Example: {"code":404,"message":"Not Found"}
swagger:model error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProductListResponse ¶
type ProductListResponse []string
ProductListResponse product list response Example: ["boundary","consul","nomad","packer","vagrant","vault","waypoint"]
swagger:model product_list_response
func (ProductListResponse) ContextValidate ¶
ContextValidate validates this product list response based on context it is used
type ProductReleaseResponseV1 ¶
type ProductReleaseResponseV1 struct {
// builds
Builds []*BuildArtifactResponseV1 `json:"builds"`
// A docker image name and tag for this release in the format `name`:`tag`
// Example: consul-enterprise:1.10
DockerNameTag string `json:"docker_name_tag,omitempty"`
// True if and only if this product release is a prerelease.
// Example: false
IsPrerelease bool `json:"is_prerelease"`
// The license class indicates if this is an enterprise product or an open source product.
// Example: enterprise
// Enum: [enterprise hcp oss]
LicenseClass string `json:"license_class,omitempty"`
// The product name
// Example: consul
// Required: true
Name *string `json:"name"`
// status
Status *ReleaseStatus `json:"status,omitempty"`
// Timestamp at which this product release was created.
// Example: 2009-11-10T23:00:00Z
// Format: date-time
TimestampCreated strfmt.DateTime `json:"timestamp_created,omitempty"`
// Timestamp when this product release was most recently updated. This
// does not consider release status changes, such as when a release
// transitions from `supported` to `unsupported` status -- that is
// tracked within the release status.
//
// Example: 2009-11-10T23:00:00Z
// Format: date-time
TimestampUpdated strfmt.DateTime `json:"timestamp_updated,omitempty"`
// URL for a blog post announcing this release; Note that patch releases
// typically are not announced on the blog, so this may refer to a major
// or minor parent release.
//
// Example: https://www.hashicorp.com/blog/announcing-consul-1-10
URLBlogpost string `json:"url_blogpost,omitempty"`
// URL for the changelog covering this release
// Example: https://github.com/hashicorp/consul/blob/main/CHANGELOG.md#1100-june-22-2021
URLChangelog string `json:"url_changelog,omitempty"`
// URL for this product's docker image(s) on DockerHub
// Example: docker.io/hashicorp/consul-enterprise:1.10
URLDockerRegistryDockerhub string `json:"url_docker_registry_dockerhub,omitempty"`
// URL for this product's docker image(s) on Amazon ECR-Public
// Example: public.ecr.aws/hashicorp/consul-enterprise:1.10
URLDockerRegistryEcr string `json:"url_docker_registry_ecr,omitempty"`
// URL for the software license applicable to this release
// Example: https://github.com/hashicorp/consul/blob/main/LICENSE
URLLicense string `json:"url_license,omitempty"`
// The project's website URL
// Example: https://www.consul.io/docs/enterprise
URLProjectWebsite string `json:"url_project_website,omitempty"`
// URL for this release's change notes
// Example: https://www.consul.io/docs/release-notes/1-10-0
URLReleaseNotes string `json:"url_release_notes,omitempty"`
// URL for this release's file containing checksums of all the included build artifacts
// Example: https://releases.hashicorp.com/consul/1.10.0+ent/consul_1.10.0+ent_SHA256SUMS
URLShasums string `json:"url_shasums,omitempty"`
// An array of URLs, each pointing to a signature file. Each signature file is a detached signature
// of the checksums file (see field `url_shasums`). Signature files may or may not embed the signing
// key ID in the filename.
//
// Example: ["https://releases.hashicorp.com/consul/1.10.0+ent/consul_1.10.0+ent_SHA256SUMS.sig","https://releases.hashicorp.com/consul/1.10.0+ent/consul_1.10.0+ent_SHA256SUMS.72D7468F.sig"]
URLShasumsSignatures []string `json:"url_shasums_signatures"`
// URL for the product's source code repository. This field is empty for enterprise products.
// Example: https://github.com/hashicorp/consul
URLSourceRepository string `json:"url_source_repository,omitempty"`
// The version of this release
// Example: 1.10.0
// Required: true
Version *string `json:"version"`
}
ProductReleaseResponseV1 All metadata for a single product release
swagger:model product_release_response_v1
func (*ProductReleaseResponseV1) ContextValidate ¶
func (m *ProductReleaseResponseV1) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product release response v1 based on the context it is used
func (*ProductReleaseResponseV1) MarshalBinary ¶
func (m *ProductReleaseResponseV1) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductReleaseResponseV1) UnmarshalBinary ¶
func (m *ProductReleaseResponseV1) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductReleasesResponseV1 ¶
type ProductReleasesResponseV1 []*ProductReleaseResponseV1
ProductReleasesResponseV1 product releases response v1
swagger:model product_releases_response_v1
func (ProductReleasesResponseV1) ContextValidate ¶
func (m ProductReleasesResponseV1) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product releases response v1 based on the context it is used
type ReleaseStatus ¶
type ReleaseStatus struct {
// Provides information about the most recent change; required when state="withdrawn"
Message string `json:"message,omitempty"`
// The state name of the release
// Enum: [supported unsupported withdrawn]
State string `json:"state,omitempty"`
// The timestamp when the release status was last updated
// Example: 2009-11-10T23:00:00Z
// Read Only: true
// Format: date-time
TimestampUpdated strfmt.DateTime `json:"timestamp_updated,omitempty"`
}
ReleaseStatus Status of the product release Example: {"message":"This release is supported","state":"supported"}
swagger:model release_status
func (*ReleaseStatus) ContextValidate ¶
ContextValidate validate this release status based on the context it is used
func (*ReleaseStatus) MarshalBinary ¶
func (m *ReleaseStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReleaseStatus) UnmarshalBinary ¶
func (m *ReleaseStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
Click to show internal directories.
Click to hide internal directories.