containerregistryv1

type AccountSettings struct {
	// Opt in to IBM Cloud Container Registry publishing platform metrics.
	PlatformMetrics *bool `json:"platform_metrics,omitempty"`
}

type AnalyzeRetentionPolicyOptions struct {
	// The namespace to which the retention policy is attached.
	Namespace *string `json:"namespace" validate:"required"`

	// Determines how many images are retained in each repository when the retention policy is processed. The value -1
	// denotes 'Unlimited' (all images are retained).
	ImagesPerRepo *int64 `json:"images_per_repo,omitempty"`

	// Determines whether untagged images are retained when the retention policy is processed. The value is false by
	// default, which means that  untagged images can be deleted when the policy runs.
	RetainUntagged *bool `json:"retain_untagged,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type AssignNamespaceOptions struct {
	// The ID of the resource group to which you want to add the namespace.
	XAuthResourceGroup *string `json:"X-Auth-Resource-Group" validate:"required"`

	// The name of the namespace that you want to udpate.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type AuthOptions struct {
	// Enable role based authorization when authenticating with IBM Cloud IAM.
	IamAuthz *bool `json:"iam_authz,omitempty"`

	// Restrict account to only be able to push and pull images over private connections.
	PrivateOnly *bool `json:"private_only,omitempty"`
}

type BulkDeleteImagesOptions struct {
	// The full IBM Cloud registry path to the images that you want to delete, including its digest. All tags for the
	// supplied digest are removed.
	BulkDelete []string `json:"BulkDelete" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Config struct {
	// True if command is already escaped (Windows specific).
	ArgsEscaped *bool `json:"ArgsEscaped,omitempty"`

	// If true, standard error is attached.
	AttachStderr *bool `json:"AttachStderr,omitempty"`

	// If true, standard input is attached, which makes possible user interaction.
	AttachStdin *bool `json:"AttachStdin,omitempty"`

	// If true, standard output is attached.
	AttachStdout *bool `json:"AttachStdout,omitempty"`

	// Command that is run when starting the container.
	Cmd []string `json:"Cmd,omitempty"`

	// The FQDN for the container.
	Domainname *string `json:"Domainname,omitempty"`

	// Entrypoint to run when starting the container.
	Entrypoint []string `json:"Entrypoint,omitempty"`

	// List of environment variables to set in the container.
	Env []string `json:"Env,omitempty"`

	// A list of exposed ports in a format [123:{},456:{}].
	ExposedPorts map[string]interface{} `json:"ExposedPorts,omitempty"`

	Healthcheck *HealthConfig `json:"Healthcheck,omitempty"`

	// The host name of the container.
	Hostname *string `json:"Hostname,omitempty"`

	// Name of the image as it was passed by the operator (eg. could be symbolic).
	Image *string `json:"Image,omitempty"`

	// List of labels set to this container.
	Labels map[string]string `json:"Labels,omitempty"`

	// The MAC Address of the container.
	MacAddress *string `json:"MacAddress,omitempty"`

	// If true, containers are not given network access.
	NetworkDisabled *bool `json:"NetworkDisabled,omitempty"`

	// ONBUILD metadata that were defined on the image Dockerfile
	// https://docs.docker.com/engine/reference/builder/#onbuild.
	OnBuild []string `json:"OnBuild,omitempty"`

	// Open stdin.
	OpenStdin *bool `json:"OpenStdin,omitempty"`

	// Shell for shell-form of RUN, CMD, ENTRYPOINT.
	Shell []string `json:"Shell,omitempty"`

	// If true, close stdin after the 1 attached client disconnects.
	StdinOnce *bool `json:"StdinOnce,omitempty"`

	// Signal to stop a container.
	StopSignal *string `json:"StopSignal,omitempty"`

	// Timeout (in seconds) to stop a container.
	StopTimeout *int64 `json:"StopTimeout,omitempty"`

	// Attach standard streams to a tty, including stdin if it is not closed.
	Tty *bool `json:"Tty,omitempty"`

	// The user that will run the command(s) inside the container.
	User *string `json:"User,omitempty"`

	// List of volumes (mounts) used for the container.
	Volumes map[string]interface{} `json:"Volumes,omitempty"`

	// Current working directory (PWD) in the command will be launched.
	WorkingDir *string `json:"WorkingDir,omitempty"`
}

type ContainerRegistryV1 struct {
	Service *core.BaseService

	// The unique ID for your IBM Cloud account.
	Account *string
}

type ContainerRegistryV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// The unique ID for your IBM Cloud account.
	Account *string `validate:"required"`
}

type CreateNamespaceOptions struct {
	// The name of the namespace that you want to create.
	Name *string `json:"name" validate:"required,ne="`

	// The ID of the resource group to which you want to add the namespace.
	XAuthResourceGroup *string `json:"X-Auth-Resource-Group,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteImageOptions struct {
	// The full IBM Cloud registry path to the image that you want to delete, including its tag. If you do not provide a
	// specific tag, the version with the `latest` tag is removed.
	Image *string `json:"image" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteImageTagOptions struct {
	// The name of the image that you want to delete, in the format <REPOSITORY>:<TAG>.
	Image *string `json:"image" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type DeleteNamespaceOptions struct {
	// The name of the namespace that you want to delete.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetAuthOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetImageManifestOptions struct {
	// The full IBM Cloud registry path to the image that you want to inspect. Run `ibmcloud cr images` or call the `GET
	// /images/json` endpoint to review images that are in the registry.
	Image *string `json:"image" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetMessagesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetPlansOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetQuotaOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetRetentionPolicyOptions struct {
	// Gets the retention policy for the specified namespace.
	Namespace *string `json:"namespace" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type GetSettingsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type HealthConfig struct {
	// A Duration represents the elapsed time between two instants as an int64 nanosecond count.
	Interval *int64 `json:"Interval,omitempty"`

	// The number of consecutive failures needed to consider a container as unhealthy. Zero means inherit.
	Retries *int64 `json:"Retries,omitempty"`

	// The test to perform to check that the container is healthy. An empty slice means to inherit the default. The options
	// are:
	// {} : inherit healthcheck
	// {"NONE"} : disable healthcheck
	// {"CMD", args...} : exec arguments directly
	// {"CMD-SHELL", command} : run command with system's default shell.
	Test []string `json:"Test,omitempty"`

	// A Duration represents the elapsed time between two instants as an int64 nanosecond count.
	Timeout *int64 `json:"Timeout,omitempty"`
}

type ImageBulkDeleteError struct {
	// An API error code.
	Code *string `json:"code,omitempty"`

	// The English text message associated with the error code.
	Message *string `json:"message,omitempty"`
}

type ImageBulkDeleteResult struct {
	// A map of digests to the error object that explains the failure.
	Error map[string]ImageBulkDeleteError `json:"error,omitempty"`

	// A list of digests which were deleted successfully.
	Success []string `json:"success,omitempty"`
}

type ImageDeleteResult struct {
	Untagged *string `json:"Untagged,omitempty"`
}

type ImageDigest struct {
	// The build date of the image.
	Created *int64 `json:"created,omitempty"`

	// The image digest.
	ID *string `json:"id,omitempty"`

	// The type of the image, such as 'Docker Image Manifest V2, Schema 2' or 'OCI Image Manifest v1'.
	ManifestType *string `json:"manifestType,omitempty"`

	// A map of image repositories to tags.
	RepoTags map[string]interface{} `json:"repoTags,omitempty"`

	// The size of the image in bytes.
	Size *int64 `json:"size,omitempty"`
}

type ImageInspection struct {
	// The processor architecture used to build this image, and required to run it.
	Architecture *string `json:"Architecture,omitempty"`

	// The author of the image.
	Author *string `json:"Author,omitempty"`

	// A plain text description of the image.
	Comment *string `json:"Comment,omitempty"`

	// The configuration data about a container.
	Config *Config `json:"Config,omitempty"`

	// The ID of the container which created this image.
	Container *string `json:"Container,omitempty"`

	// The configuration data about a container.
	ContainerConfig *Config `json:"ContainerConfig,omitempty"`

	// The unix timestamp for the date when the image was created.
	Created *string `json:"Created,omitempty"`

	// The Docker version used to build this image.
	DockerVersion *string `json:"DockerVersion,omitempty"`

	// The image ID.
	ID *string `json:"Id,omitempty"`

	// Media type of the manifest for the image.
	ManifestType *string `json:"ManifestType,omitempty"`

	// The operating system family used to build this image, and required to run it.
	Os *string `json:"Os,omitempty"`

	// The version of the operating system used to build this image.
	OsVersion *string `json:"OsVersion,omitempty"`

	// The ID of the base image for this image.
	Parent *string `json:"Parent,omitempty"`

	// RootFS contains information about the root filesystem of a container image.
	RootFs *RootFs `json:"RootFS,omitempty"`

	// The size of the image in bytes.
	Size *int64 `json:"Size,omitempty"`

	// The sum of the size of each layer in the image in bytes.
	VirtualSize *int64 `json:"VirtualSize,omitempty"`
}

type InspectImageOptions struct {
	// The full IBM Cloud registry path to the image that you want to inspect. Run `ibmcloud cr images` or call the `GET
	// /images/json` endpoint to review images that are in the registry.
	Image *string `json:"image" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListDeletedImagesOptions struct {
	// Limit results to trash can images in the given namespace only.
	Namespace *string `json:"namespace,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListImageDigestsOptions struct {
	// ExcludeTagged returns only untagged digests.
	ExcludeTagged *bool `json:"exclude_tagged,omitempty"`

	// ExcludeVA returns the digest list with no VA scan results.
	ExcludeVa *bool `json:"exclude_va,omitempty"`

	// When true, API will return the IBM public images if they exist in the targeted region.
	IncludeIBM *bool `json:"include_ibm,omitempty"`

	// Repositories in which to restrict the output. If left empty all images for the account will be returned.
	Repositories []string `json:"repositories,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListImagesOptions struct {
	// Lists images that are stored in the specified namespace only. Query multiple namespaces by specifying this option
	// for each namespace. If this option is not specified, images from all namespaces in the specified IBM Cloud account
	// are listed.
	Namespace *string `json:"namespace,omitempty"`

	// Includes IBM-provided public images in the list of images. If this option is not specified, private images are
	// listed only. If this option is specified more than once, the last parsed setting is the setting that is used.
	IncludeIBM *bool `json:"includeIBM,omitempty"`

	// Includes private images in the list of images. If this option is not specified, private images are listed. If this
	// option is specified more than once, the last parsed setting is the setting that is used.
	IncludePrivate *bool `json:"includePrivate,omitempty"`

	// Includes tags that reference multi-architecture manifest lists in the image list. If this option is not specified,
	// tagged manifest lists are not shown in the list. If this option is specified more than once, the last parsed setting
	// is the setting that is used.
	IncludeManifestLists *bool `json:"includeManifestLists,omitempty"`

	// Displays Vulnerability Advisor status for the listed images. If this option is specified more than once, the last
	// parsed setting is the setting that is used.
	Vulnerabilities *bool `json:"vulnerabilities,omitempty"`

	// Lists images that are stored in the specified repository, under your namespaces. Query multiple repositories by
	// specifying this option for each repository. If this option is not specified, images from all repos are listed.
	Repository *string `json:"repository,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListNamespaceDetailsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListNamespacesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type ListRetentionPoliciesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Namespace struct {
	Namespace *string `json:"namespace,omitempty"`
}

type NamespaceDetails struct {
	// The IBM Cloud account that owns the namespace.
	Account *string `json:"account,omitempty"`

	// The creation date of the namespace.
	CreatedDate *string `json:"created_date,omitempty"`

	// If the namespace is assigned to a resource group, the IBM Cloud CRN representing the namespace.
	CRN *string `json:"crn,omitempty"`

	Name *string `json:"name,omitempty"`

	// The date that the namespace was assigned to a resource group.
	ResourceCreatedDate *string `json:"resource_created_date,omitempty"`

	// The ID of the resource group to which the namespace is assigned.
	ResourceGroup *string `json:"resource_group,omitempty"`

	// The date that the namespace was last updated.
	UpdatedDate *string `json:"updated_date,omitempty"`
}

type Plan struct {
	Plan *string `json:"plan,omitempty"`
}

type Quota struct {
	Limit *QuotaDetails `json:"limit,omitempty"`

	Usage *QuotaDetails `json:"usage,omitempty"`
}

type QuotaDetails struct {
	// Storage quota or usage in bytes. The value -1 denotes "Unlimited".
	StorageBytes *int64 `json:"storage_bytes,omitempty"`

	// Traffic quota or usage in bytes. The value -1 denotes "Unlimited".
	TrafficBytes *int64 `json:"traffic_bytes,omitempty"`
}

type RemoteAPIImage struct {
	ConfigurationIssueCount *int64 `json:"ConfigurationIssueCount,omitempty"`

	Created *int64 `json:"Created,omitempty"`

	DigestTags map[string][]string `json:"DigestTags,omitempty"`

	ExemptIssueCount *int64 `json:"ExemptIssueCount,omitempty"`

	ID *string `json:"Id,omitempty"`

	IssueCount *int64 `json:"IssueCount,omitempty"`

	Labels map[string]string `json:"Labels,omitempty"`

	ManifestType *string `json:"ManifestType,omitempty"`

	ParentID *string `json:"ParentId,omitempty"`

	RepoDigests []string `json:"RepoDigests,omitempty"`

	RepoTags []string `json:"RepoTags,omitempty"`

	Size *int64 `json:"Size,omitempty"`

	VirtualSize *int64 `json:"VirtualSize,omitempty"`

	VulnerabilityCount *int64 `json:"VulnerabilityCount,omitempty"`

	Vulnerable *string `json:"Vulnerable,omitempty"`
}

type RestoreImageOptions struct {
	// The name of the image that you want to restore, in the format <REPOSITORY>:<TAG>. Run `ibmcloud cr
	// trash-list` or call the `GET /trash/json` endpoint to review images that are in the trash.
	Image *string `json:"image" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type RestoreResult struct {
	// Successful is a list of tags that were restored.
	Successful []string `json:"successful,omitempty"`

	// Unsuccessful is a list of tags that were not restored because of a conflict.
	Unsuccessful []string `json:"unsuccessful,omitempty"`
}

type RestoreTagsOptions struct {
	// The full IBM Cloud registry digest reference for the digest that you want to restore such as
	// `icr.io/namespace/repo@sha256:a9be...`. Call the `GET /trash/json` endpoint to review digests that are in the trash
	// and their tags in the same repository.
	Digest *string `json:"digest" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type RetentionPolicy struct {
	// Determines how many images are retained in each repository when the retention policy is processed. The value -1
	// denotes 'Unlimited' (all images are retained).
	ImagesPerRepo *int64 `json:"images_per_repo,omitempty"`

	// The namespace to which the retention policy is attached.
	Namespace *string `json:"namespace" validate:"required"`

	// Determines whether untagged images are retained when the retention policy is processed. The value is false by
	// default, which means that  untagged images can be deleted when the policy runs.
	RetainUntagged *bool `json:"retain_untagged,omitempty"`
}

type RootFs struct {
	// Descriptor for the base layer in the image.
	BaseLayer *string `json:"BaseLayer,omitempty"`

	// Descriptors for each layer in the image.
	Layers []string `json:"Layers,omitempty"`

	// The type of filesystem.
	Type *string `json:"Type,omitempty"`
}

type SetRetentionPolicyOptions struct {
	// The namespace to which the retention policy is attached.
	Namespace *string `json:"namespace" validate:"required"`

	// Determines how many images are retained in each repository when the retention policy is processed. The value -1
	// denotes 'Unlimited' (all images are retained).
	ImagesPerRepo *int64 `json:"images_per_repo,omitempty"`

	// Determines whether untagged images are retained when the retention policy is processed. The value is false by
	// default, which means that  untagged images can be deleted when the policy runs.
	RetainUntagged *bool `json:"retain_untagged,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type TagImageOptions struct {
	// The name of the image that you want to create a new tag for, in the format <REPOSITORY>:<TAG>. Run
	// `ibmcloud cr images` or call the `GET /images/json` endpoint to review images that are in the registry.
	Fromimage *string `json:"fromimage" validate:"required"`

	// The new tag for the image, in the format <REPOSITORY>:<TAG>.
	Toimage *string `json:"toimage" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type Trash struct {
	DaysUntilExpiry *int64 `json:"daysUntilExpiry,omitempty"`

	Tags []string `json:"tags,omitempty"`
}

type UpdateAuthOptions struct {
	// Enable role based authorization when authenticating with IBM Cloud IAM.
	IamAuthz *bool `json:"iam_authz,omitempty"`

	// Restrict account to only be able to push and pull images over private connections.
	PrivateOnly *bool `json:"private_only,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type UpdatePlansOptions struct {
	Plan *string `json:"plan,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type UpdateQuotaOptions struct {
	// Storage quota in megabytes. The value -1 denotes "Unlimited".
	StorageMegabytes *int64 `json:"storage_megabytes,omitempty"`

	// Traffic quota in megabytes. The value -1 denotes "Unlimited".
	TrafficMegabytes *int64 `json:"traffic_megabytes,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

type UpdateSettingsOptions struct {
	// Opt in to IBM Cloud Container Registry publishing platform metrics.
	PlatformMetrics *bool `json:"platform_metrics,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}