Index
ArtifactRegistry(interface)AptArtifact(message)AptArtifact.PackageType(enum)Attachment(message)BatchDeleteVersionsMetadata(message)BatchDeleteVersionsRequest(message)CleanupPolicy(message)CleanupPolicy.Action(enum)CleanupPolicyCondition(message)CleanupPolicyCondition.TagState(enum)CleanupPolicyMostRecentVersions(message)CreateAttachmentRequest(message)CreateRepositoryRequest(message)CreateRuleRequest(message)CreateTagRequest(message)DeleteAttachmentRequest(message)DeleteFileRequest(message)DeletePackageRequest(message)DeleteRepositoryRequest(message)DeleteRuleRequest(message)DeleteTagRequest(message)DeleteVersionRequest(message)DockerImage(message)File(message)GenericArtifact(message)GetAttachmentRequest(message)GetDockerImageRequest(message)GetFileRequest(message)GetMavenArtifactRequest(message)GetNpmPackageRequest(message)GetPackageRequest(message)GetProjectSettingsRequest(message)GetPythonPackageRequest(message)GetRepositoryRequest(message)GetRuleRequest(message)GetTagRequest(message)GetVPCSCConfigRequest(message)GetVersionRequest(message)GoModule(message)GoogetArtifact(message)Hash(message)Hash.HashType(enum)ImportAptArtifactsErrorInfo(message)ImportAptArtifactsGcsSource(message)ImportAptArtifactsMetadata(message)ImportAptArtifactsRequest(message)ImportAptArtifactsResponse(message)ImportGoogetArtifactsErrorInfo(message)ImportGoogetArtifactsGcsSource(message)ImportGoogetArtifactsMetadata(message)ImportGoogetArtifactsRequest(message)ImportGoogetArtifactsResponse(message)ImportYumArtifactsErrorInfo(message)ImportYumArtifactsGcsSource(message)ImportYumArtifactsMetadata(message)ImportYumArtifactsRequest(message)ImportYumArtifactsResponse(message)KfpArtifact(message)ListAttachmentsRequest(message)ListAttachmentsResponse(message)ListDockerImagesRequest(message)ListDockerImagesResponse(message)ListFilesRequest(message)ListFilesResponse(message)ListMavenArtifactsRequest(message)ListMavenArtifactsResponse(message)ListNpmPackagesRequest(message)ListNpmPackagesResponse(message)ListPackagesRequest(message)ListPackagesResponse(message)ListPythonPackagesRequest(message)ListPythonPackagesResponse(message)ListRepositoriesRequest(message)ListRepositoriesResponse(message)ListRulesRequest(message)ListRulesResponse(message)ListTagsRequest(message)ListTagsResponse(message)ListVersionsRequest(message)ListVersionsResponse(message)MavenArtifact(message)NpmPackage(message)OperationMetadata(message)Package(message)ProjectSettings(message)ProjectSettings.RedirectionState(enum)PythonPackage(message)RemoteRepositoryConfig(message)RemoteRepositoryConfig.AptRepository(message)RemoteRepositoryConfig.AptRepository.CustomRepository(message)RemoteRepositoryConfig.AptRepository.PublicRepository(message)RemoteRepositoryConfig.AptRepository.PublicRepository.RepositoryBase(enum)RemoteRepositoryConfig.CommonRemoteRepository(message)RemoteRepositoryConfig.DockerRepository(message)RemoteRepositoryConfig.DockerRepository.CustomRepository(message)RemoteRepositoryConfig.DockerRepository.PublicRepository(enum)RemoteRepositoryConfig.MavenRepository(message)RemoteRepositoryConfig.MavenRepository.CustomRepository(message)RemoteRepositoryConfig.MavenRepository.PublicRepository(enum)RemoteRepositoryConfig.NpmRepository(message)RemoteRepositoryConfig.NpmRepository.CustomRepository(message)RemoteRepositoryConfig.NpmRepository.PublicRepository(enum)RemoteRepositoryConfig.PythonRepository(message)RemoteRepositoryConfig.PythonRepository.CustomRepository(message)RemoteRepositoryConfig.PythonRepository.PublicRepository(enum)RemoteRepositoryConfig.UpstreamCredentials(message)RemoteRepositoryConfig.UpstreamCredentials.UsernamePasswordCredentials(message)RemoteRepositoryConfig.YumRepository(message)RemoteRepositoryConfig.YumRepository.CustomRepository(message)RemoteRepositoryConfig.YumRepository.PublicRepository(message)RemoteRepositoryConfig.YumRepository.PublicRepository.RepositoryBase(enum)Repository(message)Repository.DockerRepositoryConfig(message)Repository.Format(enum)Repository.MavenRepositoryConfig(message)Repository.MavenRepositoryConfig.VersionPolicy(enum)Repository.Mode(enum)Rule(message)Rule.Action(enum)Rule.Operation(enum)Tag(message)UpdateFileRequest(message)UpdatePackageRequest(message)UpdateProjectSettingsRequest(message)UpdateRepositoryRequest(message)UpdateRuleRequest(message)UpdateTagRequest(message)UpdateVPCSCConfigRequest(message)UpdateVersionRequest(message)UploadAptArtifactMetadata(message)UploadAptArtifactResponse(message)UploadFileMetadata(message)UploadGenericArtifactMetadata(message)UploadGoModuleMetadata(message)UploadGoogetArtifactMetadata(message)UploadGoogetArtifactResponse(message)UploadKfpArtifactMetadata(message)UploadYumArtifactMetadata(message)UploadYumArtifactResponse(message)UpstreamPolicy(message)VPCSCConfig(message)VPCSCConfig.VPCSCPolicy(enum)Version(message)VersionView(enum)VirtualRepositoryConfig(message)YumArtifact(message)YumArtifact.PackageType(enum)
ArtifactRegistry
The Artifact Registry API service.
Artifact Registry is an artifact management system for storing artifacts from different package management systems.
The resources managed by this API are:
- Repositories, which group packages and their data.
- Packages, which group versions and their tags.
- Versions, which are specific forms of a package.
- Tags, which represent alternative names for versions.
- Files, which contain content and are optionally associated with a Package or Version.
| BatchDeleteVersions |
|---|
|
Deletes multiple versions across a repository. The returned operation will complete once the versions have been deleted.
|
| CreateAttachment |
|---|
|
Creates an attachment. The returned Operation will finish once the attachment has been created. Its response will be the created attachment.
|
| CreateRepository |
|---|
|
Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
|
| CreateRule |
|---|
|
Creates a rule.
|
| CreateTag |
|---|
|
Creates a tag.
|
| DeleteAttachment |
|---|
|
Deletes an attachment. The returned Operation will finish once the attachments has been deleted. It will not have any Operation metadata and will return a
|
| DeleteFile |
|---|
|
Deletes a file and all of its content. It is only allowed on generic repositories. The returned operation will complete once the file has been deleted.
|
| DeletePackage |
|---|
|
Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
|
| DeleteRepository |
|---|
|
Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.
|
| DeleteRule |
|---|
|
Deletes a rule.
|
| DeleteTag |
|---|
|
Deletes a tag.
|
| DeleteVersion |
|---|
|
Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
|
| GetAttachment |
|---|
|
Gets an attachment.
|
| GetDockerImage |
|---|
|
Gets a docker image.
|
| GetFile |
|---|
|
Gets a file.
|
| GetIamPolicy |
|---|
|
Gets the IAM policy for a given resource.
|
| GetMavenArtifact |
|---|
|
Gets a maven artifact.
|
| GetNpmPackage |
|---|
|
Gets a npm package.
|
| GetPackage |
|---|
|
Gets a package.
|
| GetProjectSettings |
|---|
|
Retrieves the Settings for the Project.
|
| GetPythonPackage |
|---|
|
Gets a python package.
|
| GetRepository |
|---|
|
Gets a repository.
|
| GetRule |
|---|
|
Gets a rule.
|
| GetTag |
|---|
|
Gets a tag.
|
| GetVPCSCConfig |
|---|
|
Retrieves the VPCSC Config for the Project.
|
| GetVersion |
|---|
|
Gets a version
|
| ImportAptArtifacts |
|---|
|
Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
|
| ImportGoogetArtifacts |
|---|
|
Imports GooGet artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
|
| ImportYumArtifacts |
|---|
|
Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
|
| ListAttachments |
|---|
|
Lists attachments.
|
| ListDockerImages |
|---|
|
Lists docker images.
|
| ListFiles |
|---|
|
Lists files.
|
| ListMavenArtifacts |
|---|
|
Lists maven artifacts.
|
| ListNpmPackages |
|---|
|
Lists npm packages.
|
| ListPackages |
|---|
|
Lists packages.
|
| ListPythonPackages |
|---|
|
Lists python packages.
|
| ListRepositories |
|---|
|
Lists repositories.
|
| ListRules |
|---|
|
Lists rules.
|
| ListTags |
|---|
|
Lists tags.
|
| ListVersions |
|---|
|
Lists versions.
|
| SetIamPolicy |
|---|
|
Updates the IAM policy for a given resource.
|
| TestIamPermissions |
|---|
|
Tests if the caller has a list of permissions on a resource.
|
| UpdateFile |
|---|
|
Updates a file.
|
| UpdatePackage |
|---|
|
Updates a package.
|
| UpdateProjectSettings |
|---|
|
Updates the Settings for the Project.
|
| UpdateRepository |
|---|
|
Updates a repository.
|
| UpdateRule |
|---|
|
Updates a rule.
|
| UpdateTag |
|---|
|
Updates a tag.
|
| UpdateVPCSCConfig |
|---|
|
Updates the VPCSC Config for the Project.
|
| UpdateVersion |
|---|
|
Updates a version.
|
AptArtifact
A detailed representation of an Apt artifact. Information in the record is derived from the archive's control file. See https://www.debian.org/doc/debian-policy/ch-controlfields.html
| Fields | |
|---|---|
name |
Output only. The Artifact Registry resource name of the artifact. |
package_name |
Output only. The Apt package name of the artifact. |
package_type |
Output only. An artifact is a binary or source package. |
architecture |
Output only. Operating system architecture of the artifact. |
component |
Output only. Repository component of the artifact. |
control_file |
Output only. Contents of the artifact's control metadata file. |
PackageType
Package type is either binary or source.
| Enums | |
|---|---|
PACKAGE_TYPE_UNSPECIFIED |
Package type is not specified. |
BINARY |
Binary package. |
SOURCE |
Source package. |
Attachment
An Attachment refers to additional metadata that can be attached to artifacts in Artifact Registry. An attachment consists of one or more files.
| Fields | |
|---|---|
name |
The name of the attachment. E.g. |
target |
Required. The target the attachment is for, can be a Version, Package or Repository. E.g. |
type |
Type of attachment. E.g. |
attachment_namespace |
The namespace this attachment belongs to. E.g. If an attachment is created by artifact analysis, namespace is set to |
annotations |
Optional. User annotations. These attributes can only be set and used by the user, and not by Artifact Registry. See https://google.aip.dev/128#annotations for more details such as format and size limitations. |
create_time |
Output only. The time when the attachment was created. |
update_time |
Output only. The time when the attachment was last updated. |
files[] |
Required. The files that belong to this attachment. If the file ID part contains slashes, they are escaped. E.g. |
oci_version_name |
Output only. The name of the OCI version that this attachment created. Only populated for Docker attachments. E.g. |
BatchDeleteVersionsMetadata
The metadata of an LRO from deleting multiple versions.
| Fields | |
|---|---|
failed_versions[] |
The versions the operation failed to delete. |
BatchDeleteVersionsRequest
The request to delete multiple versions across a repository.
| Fields | |
|---|---|
parent |
The name of the repository holding all requested versions. |
names[] |
Required. The names of the versions to delete. A maximum of 10000 versions can be deleted in a batch. Authorization requires the following IAM permission on the specified resource
|
validate_only |
If true, the request is performed without deleting data, following AIP-163. |
CleanupPolicy
Artifact policy configuration for repository cleanup policies.
| Fields | |
|---|---|
id |
The user-provided ID of the cleanup policy. |
action |
Policy action. |
Union field
|
|
condition |
Policy condition for matching versions. |
most_recent_versions |
Policy condition for retaining a minimum number of versions. May only be specified with a Keep action. |
Action
Action type for a cleanup policy.
| Enums | |
|---|---|
ACTION_UNSPECIFIED |
Action not specified. |
DELETE |
Delete action. |
KEEP |
Keep action. |
CleanupPolicyCondition
CleanupPolicyCondition is a set of conditions attached to a CleanupPolicy. If multiple entries are set, all must be satisfied for the condition to be satisfied.
| Fields | |
|---|---|
tag_prefixes[] |
Match versions by tag prefix. Applied on any prefix match. |
version_name_prefixes[] |
Match versions by version name prefix. Applied on any prefix match. |
package_name_prefixes[] |
Match versions by package prefix. Applied on any prefix match. |
tag_state |
Match versions by tag status. |
older_than |
Match versions older than a duration. |
newer_than |
Match versions newer than a duration. |
TagState
Statuses applying to versions.
| Enums | |
|---|---|
TAG_STATE_UNSPECIFIED |
Tag status not specified. |
TAGGED |
Applies to tagged versions only. |
UNTAGGED |
Applies to untagged versions only. |
ANY |
Applies to all versions. |
CleanupPolicyMostRecentVersions
CleanupPolicyMostRecentVersions is an alternate condition of a CleanupPolicy for retaining a minimum number of versions.
| Fields | |
|---|---|
package_name_prefixes[] |
List of package name prefixes that will apply this rule. |
keep_count |
Minimum number of versions to keep. |
CreateAttachmentRequest
The request to create a new attachment.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource where the attachment will be created. Authorization requires the following IAM permission on the specified resource
|
attachment_id |
Required. The attachment id to use for this attachment. |
attachment |
Required. The attachment to be created. |
CreateRepositoryRequest
The request to create a new repository.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource where the repository will be created. Authorization requires the following IAM permission on the specified resource
|
repository_id |
Required. The repository id to use for this repository. |
repository |
Required. The repository to be created. |
CreateRuleRequest
The request to create a new rule.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource where the rule will be created. Authorization requires the following IAM permission on the specified resource
|
rule_id |
The rule id to use for this repository. |
rule |
The rule to be created. |
CreateTagRequest
The request to create a new tag.
| Fields | |
|---|---|
parent |
The name of the parent resource where the tag will be created. Authorization requires the following IAM permission on the specified resource
|
tag_id |
The tag id to use for this repository. |
tag |
The tag to be created. |
DeleteAttachmentRequest
The request to delete an attachment.
| Fields | |
|---|---|
name |
Required. The name of the attachment to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteFileRequest
The request to delete a file.
| Fields | |
|---|---|
name |
Required. The name of the file to delete. Authorization requires the following IAM permission on the specified resource
|
DeletePackageRequest
The request to delete a package.
| Fields | |
|---|---|
name |
Required. The name of the package to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteRepositoryRequest
The request to delete a repository.
| Fields | |
|---|---|
name |
Required. The name of the repository to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteRuleRequest
The request to delete a rule.
| Fields | |
|---|---|
name |
Required. The name of the rule to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteTagRequest
The request to delete a tag.
| Fields | |
|---|---|
name |
The name of the tag to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteVersionRequest
The request to delete a version.
| Fields | |
|---|---|
name |
The name of the version to delete. Authorization requires the following IAM permission on the specified resource
|
force |
By default, a version that is tagged may not be deleted. If force=true, the version and any tags pointing to the version are deleted. |
DockerImage
DockerImage represents a docker artifact. The following fields are returned as untyped metadata in the Version resource, using camelcase keys (i.e. metadata.imageSizeBytes): * imageSizeBytes * mediaType * buildTime
| Fields | |
|---|---|
name |
Required. registry_location, project_id, repository_name and image id forms a unique image name: |
uri |
Required. URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf |
tags[] |
Tags attached to this image. |
image_size_bytes |
Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource. |
upload_time |
Time the image was uploaded. |
media_type |
Media type of this image, e.g. "application/vnd.docker.distribution.manifest.v2+json". This field is returned as the 'metadata.mediaType' field in the Version resource. |
build_time |
The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor. |
update_time |
Output only. The time when the docker image was last updated. |
File
Files store content that is potentially associated with Packages or Versions.
| Fields | |
|---|---|
name |
The name of the file, for example: |
size_bytes |
The size of the File in bytes. |
hashes[] |
The hashes of the file content. |
create_time |
Output only. The time when the File was created. |
update_time |
Output only. The time when the File was last updated. |
owner |
The name of the Package or Version that owns this file, if any. |
fetch_time |
Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote. |
annotations |
Optional. Client specified annotations. |
GenericArtifact
GenericArtifact represents a generic artifact
| Fields | |
|---|---|
name |
Resource name of the generic artifact. project, location, repository, package_id and version_id create a unique generic artifact. i.e. "projects/test-project/locations/us-west4/repositories/test-repo/ genericArtifacts/package_id:version_id" |
version |
The version of the generic artifact. |
create_time |
Output only. The time when the Generic module is created. |
update_time |
Output only. The time when the Generic module is updated. |
GetAttachmentRequest
The request to retrieve an attachment.
| Fields | |
|---|---|
name |
Required. The name of the attachment to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetDockerImageRequest
The request to get docker images.
| Fields | |
|---|---|
name |
Required. The name of the docker images. Authorization requires the following IAM permission on the specified resource
|
GetFileRequest
The request to retrieve a file.
| Fields | |
|---|---|
name |
Required. The name of the file to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetMavenArtifactRequest
The request to get maven artifacts.
| Fields | |
|---|---|
name |
Required. The name of the maven artifact. Authorization requires the following IAM permission on the specified resource
|
GetNpmPackageRequest
The request to get npm packages.
| Fields | |
|---|---|
name |
Required. The name of the npm package. Authorization requires the following IAM permission on the specified resource
|
GetPackageRequest
The request to retrieve a package.
| Fields | |
|---|---|
name |
Required. The name of the package to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetProjectSettingsRequest
Gets the redirection status for a project.
| Fields | |
|---|---|
name |
Required. The name of the projectSettings resource. Authorization requires the following IAM permission on the specified resource
|
GetPythonPackageRequest
The request to get python packages.
| Fields | |
|---|---|
name |
Required. The name of the python package. Authorization requires the following IAM permission on the specified resource
|
GetRepositoryRequest
The request to retrieve a repository.
| Fields | |
|---|---|
name |
Required. The name of the repository to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetRuleRequest
The request to retrieve a rule.
| Fields | |
|---|---|
name |
Required. The name of the rule to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetTagRequest
The request to retrieve a tag.
| Fields | |
|---|---|
name |
The name of the tag to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetVPCSCConfigRequest
Gets the VPC SC config for a project.
| Fields | |
|---|---|
name |
Required. The name of the VPCSCConfig resource. Authorization requires the following IAM permission on the specified resource
|
GetVersionRequest
The request to retrieve a version.
| Fields | |
|---|---|
name |
The name of the version to retrieve. Authorization requires the following IAM permission on the specified resource
|
view |
The view that should be returned in the response. |
GoModule
GoModule represents a Go module.
| Fields | |
|---|---|
name |
The resource name of a Go module. |
version |
The version of the Go module. Must be a valid canonical version as defined in https://go.dev/ref/mod#glos-canonical-version. |
create_time |
Output only. The time when the Go module is created. |
update_time |
Output only. The time when the Go module is updated. |
GoogetArtifact
A detailed representation of a GooGet artifact.
| Fields | |
|---|---|
name |
Output only. The Artifact Registry resource name of the artifact. |
package_name |
Output only. The GooGet package name of the artifact. |
architecture |
Output only. Operating system architecture of the artifact. |
Hash
A hash of file content.
| Fields | |
|---|---|
type |
The algorithm used to compute the hash value. |
value |
The hash value. |
HashType
The algorithm used to compute the hash.
| Enums | |
|---|---|
HASH_TYPE_UNSPECIFIED |
Unspecified. |
SHA256 |
SHA256 hash. |
MD5 |
MD5 hash. |
ImportAptArtifactsErrorInfo
Error information explaining why a package was not imported.
| Fields | |
|---|---|
error |
The detailed error status. |
Union field source. The source that was not imported. source can be only one of the following: |
|
gcs_source |
Google Cloud Storage location requested. |
ImportAptArtifactsGcsSource
Google Cloud Storage location where the artifacts currently reside.
| Fields | |
|---|---|
uris[] |
Cloud Storage paths URI (e.g., gs://my_bucket//my_object). |
use_wildcards |
Supports URI wildcards for matching multiple objects from a single URI. |
ImportAptArtifactsMetadata
This type has no fields.
The operation metadata for importing artifacts.
ImportAptArtifactsRequest
The request to import new apt artifacts.
| Fields | |
|---|---|
parent |
The name of the parent resource where the artifacts will be imported. Authorization requires the following IAM permission on the specified resource
|
Union field source. The source location of the package binaries. source can be only one of the following: |
|
gcs_source |
Google Cloud Storage location where input content is located. |
ImportAptArtifactsResponse
The response message from importing APT artifacts.
| Fields | |
|---|---|
apt_artifacts[] |
The Apt artifacts imported. |
errors[] |
Detailed error info for packages that were not imported. |
ImportGoogetArtifactsErrorInfo
Error information explaining why a package was not imported.
| Fields | |
|---|---|
error |
The detailed error status. |
Union field source. The source that was not imported. source can be only one of the following: |
|
gcs_source |
Google Cloud Storage location requested. |
ImportGoogetArtifactsGcsSource
Google Cloud Storage location where the artifacts currently reside.
| Fields | |
|---|---|
uris[] |
Cloud Storage paths URI (e.g., |
use_wildcards |
Supports URI wildcards for matching multiple objects from a single URI. |
ImportGoogetArtifactsMetadata
This type has no fields.
The operation metadata for importing artifacts.
ImportGoogetArtifactsRequest
The request to import new googet artifacts.
| Fields | |
|---|---|
parent |
The name of the parent resource where the artifacts will be imported. Authorization requires the following IAM permission on the specified resource
|
Union field source. The source location of the package binaries. source can be only one of the following: |
|
gcs_source |
Google Cloud Storage location where input content is located. |
ImportGoogetArtifactsResponse
The response message from importing artifacts.
| Fields | |
|---|---|
googet_artifacts[] |
The GooGet artifacts updated. |
errors[] |
Detailed error info for packages that were not imported. |
ImportYumArtifactsErrorInfo
Error information explaining why a package was not imported.
| Fields | |
|---|---|
error |
The detailed error status. |
Union field source. The source that was not imported. source can be only one of the following: |
|
gcs_source |
Google Cloud Storage location requested. |
ImportYumArtifactsGcsSource
Google Cloud Storage location where the artifacts currently reside.
| Fields | |
|---|---|
uris[] |
Cloud Storage paths URI (e.g., gs://my_bucket//my_object). |
use_wildcards |
Supports URI wildcards for matching multiple objects from a single URI. |
ImportYumArtifactsMetadata
This type has no fields.
The operation metadata for importing artifacts.
ImportYumArtifactsRequest
The request to import new yum artifacts.
| Fields | |
|---|---|
parent |
The name of the parent resource where the artifacts will be imported. Authorization requires the following IAM permission on the specified resource
|
Union field source. The source location of the package binaries. source can be only one of the following: |
|
gcs_source |
Google Cloud Storage location where input content is located. |
ImportYumArtifactsResponse
The response message from importing YUM artifacts.
| Fields | |
|---|---|
yum_artifacts[] |
The yum artifacts imported. |
errors[] |
Detailed error info for packages that were not imported. |
KfpArtifact
A detailed representation of a KFP artifact.
| Fields | |
|---|---|
name |
Output only. Resource name of the KFP artifact. Since users don't directly interact with this resource, the name will be derived from the associated version. For example, when version = ".../versions/sha256:abcdef...", the name will be ".../kfpArtifacts/sha256:abcdef...". |
version |
The version associated with the KFP artifact. Must follow the Semantic Versioning standard. |
ListAttachmentsRequest
The request to list attachments.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose attachments will be listed. Authorization requires the following IAM permission on the specified resource
|
filter |
Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
|
page_size |
The maximum number of attachments to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListAttachmentsResponse
The response from listing attachments.
| Fields | |
|---|---|
attachments[] |
The attachments returned. |
next_page_token |
The token to retrieve the next page of attachments, or empty if there are no more attachments to return. |
ListDockerImagesRequest
The request to list docker images.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose docker images will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of artifacts to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
order_by |
The field to order the results by. |
ListDockerImagesResponse
The response from listing docker images.
| Fields | |
|---|---|
docker_images[] |
The docker images returned. |
next_page_token |
The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return. |
ListFilesRequest
The request to list files.
| Fields | |
|---|---|
parent |
Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 Authorization requires the following IAM permission on the specified resource
|
filter |
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
Examples of using a filter: To filter the results of your request to files with the name
You can also use wildcards to match any number of characters before or after the value:
To filter the results of your request to files owned by the version
To filter the results of your request to files with the annotation key-value pair [
To filter just for a specific annotation key
If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [
You can also filter with annotations with a wildcard to match any number of characters before or after the value:
|
page_size |
The maximum number of files to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
order_by |
The field to order the results by. |
ListFilesResponse
The response from listing files.
| Fields | |
|---|---|
files[] |
The files returned. |
next_page_token |
The token to retrieve the next page of files, or empty if there are no more files to return. |
ListMavenArtifactsRequest
The request to list maven artifacts.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose maven artifacts will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of artifacts to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListMavenArtifactsResponse
The response from listing maven artifacts.
| Fields | |
|---|---|
maven_artifacts[] |
The maven artifacts returned. |
next_page_token |
The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return. |
ListNpmPackagesRequest
The request to list npm packages.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose npm packages will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of artifacts to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListNpmPackagesResponse
The response from listing npm packages.
| Fields | |
|---|---|
npm_packages[] |
The npm packages returned. |
next_page_token |
The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return. |
ListPackagesRequest
The request to list packages.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose packages will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of packages to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
filter |
Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
Examples of using a filter: To filter the results of your request to packages with the name
You can also use wildcards to match any number of characters before or after the value:
To filter the results of your request to packages with the annotation key-value pair [
To filter the results just for a specific annotation key
If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [
You can also filter with annotations with a wildcard to match any number of characters before or after the value:
|
order_by |
Optional. The field to order the results by. |
ListPackagesResponse
The response from listing packages.
| Fields | |
|---|---|
packages[] |
The packages returned. |
next_page_token |
The token to retrieve the next page of packages, or empty if there are no more packages to return. |
ListPythonPackagesRequest
The request to list python packages.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose python packages will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of artifacts to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListPythonPackagesResponse
The response from listing python packages.
| Fields | |
|---|---|
python_packages[] |
The python packages returned. |
next_page_token |
The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return. |
ListRepositoriesRequest
The request to list repositories.
| Fields | |
|---|---|
parent |
Required. The name of the parent resource whose repositories will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of repositories to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
filter |
Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
Examples of using a filter: To filter the results of your request to repositories with the name
You can also use wildcards to match any number of characters before or after the value:
|
order_by |
Optional. The field to order the results by. |
ListRepositoriesResponse
The response from listing repositories.
| Fields | |
|---|---|
repositories[] |
The repositories returned. |
next_page_token |
The token to retrieve the next page of repositories, or empty if there are no more repositories to return. |
ListRulesRequest
The request to list rules.
| Fields | |
|---|---|
parent |
Required. The name of the parent repository whose rules will be listed. For example: Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of rules to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListRulesResponse
The response from listing rules.
| Fields | |
|---|---|
rules[] |
The rules returned. |
next_page_token |
The token to retrieve the next page of rules, or empty if there are no more rules to return. |
ListTagsRequest
The request to list tags.
| Fields | |
|---|---|
parent |
The name of the parent package whose tags will be listed. For example: Authorization requires the following IAM permission on the specified resource
|
filter |
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
Examples of using a filter: To filter the results of your request to tags with the name
You can also use wildcards to match any number of characters before or after the value:
To filter the results of your request to tags applied to the version
|
page_size |
The maximum number of tags to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListTagsResponse
The response from listing tags.
| Fields | |
|---|---|
tags[] |
The tags returned. |
next_page_token |
The token to retrieve the next page of tags, or empty if there are no more tags to return. |
ListVersionsRequest
The request to list versions.
| Fields | |
|---|---|
parent |
The name of the parent resource whose versions will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of versions to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
view |
The view that should be returned in the response. |
order_by |
Optional. The field to order the results by. |
filter |
Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
Examples of using a filter: To filter the results of your request to versions with the name
You can also use wildcards to match any number of characters before or after the value:
To filter the results of your request to versions with the annotation key-value pair [
To filter just for a specific annotation key
If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [
You can also filter with annotations with a wildcard to match any number of characters before or after the value:
|
ListVersionsResponse
The response from listing versions.
| Fields | |
|---|---|
versions[] |
The versions returned. |
next_page_token |
The token to retrieve the next page of versions, or empty if there are no more versions to return. |
MavenArtifact
MavenArtifact represents a maven artifact.
| Fields | |
|---|---|
name |
Required. registry_location, project_id, repository_name and maven_artifact forms a unique artifact For example, "projects/test-project/locations/us-west4/repositories/test-repo/mavenArtifacts/ com.google.guava:guava:31.0-jre", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "com.google.guava:guava:31.0-jre" is the maven artifact. |
pom_uri |
Required. URL to access the pom file of the artifact. Example: us-west4-maven.pkg.dev/test-project/test-repo/com/google/guava/guava/31.0/guava-31.0.pom |
group_id |
Group ID for the artifact. Example: com.google.guava |
artifact_id |
Artifact ID for the artifact. |
version |
Version of this artifact. |
create_time |
Output only. Time the artifact was created. |
update_time |
Output only. Time the artifact was updated. |
NpmPackage
NpmPackage represents an npm artifact.
| Fields | |
|---|---|
name |
Required. registry_location, project_id, repository_name and npm_package forms a unique package For example, "projects/test-project/locations/us-west4/repositories/test-repo/npmPackages/ npm_test:1.0.0", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and npm_test:1.0.0" is the npm package. |
package_name |
Package for the artifact. |
version |
Version of this package. |
tags[] |
Tags attached to this package. |
create_time |
Output only. Time the package was created. |
update_time |
Output only. Time the package was updated. |
OperationMetadata
This type has no fields.
Metadata type for longrunning-operations, currently empty.
Package
Packages are named collections of versions.
| Fields | |
|---|---|
name |
The name of the package, for example: |
display_name |
The display name of the package. |
create_time |
The time when the package was created. |
update_time |
The time when the package was last updated. This includes publishing a new version of the package. |
annotations |
Optional. Client specified annotations. |
ProjectSettings
The Artifact Registry settings that apply to a Project.
| Fields | |
|---|---|
name |
The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set |
legacy_redirection_state |
The redirection state of the legacy repositories in this project. |
pull_percent |
The percentage of pull traffic to redirect from GCR to AR when using partial redirection. |
RedirectionState
The possible redirection states for legacy repositories.
| Enums | |
|---|---|
REDIRECTION_STATE_UNSPECIFIED |
No redirection status has been set. |
REDIRECTION_FROM_GCR_IO_DISABLED |
Redirection is disabled. |
REDIRECTION_FROM_GCR_IO_ENABLED |
Redirection is enabled. |
REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING |
Redirection is enabled and missing images are copied from GCR |
REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING |
Redirection is partially enabled and missing images are copied from GCR |
PythonPackage
PythonPackage represents a python artifact.
| Fields | |
|---|---|
name |
Required. registry_location, project_id, repository_name and python_package forms a unique package name: |
uri |
Required. URL to access the package. Example: us-west4-python.pkg.dev/test-project/test-repo/python_package/file-name-1.0.0.tar.gz |
package_name |
Package for the artifact. |
version |
Version of this package. |
create_time |
Output only. Time the package was created. |
update_time |
Output only. Time the package was updated. |
RemoteRepositoryConfig
Remote repository configuration.
| Fields | |
|---|---|
description |
The description of the remote source. |
upstream_credentials |
Optional. The credentials used to access the remote repository. |
disable_upstream_validation |
Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials. |
Union field remote_source. Settings specific to the remote repository. remote_source can be only one of the following: |
|
docker_repository |
Specific settings for a Docker remote repository. |
maven_repository |
Specific settings for a Maven remote repository. |
npm_repository |
Specific settings for an Npm remote repository. |
python_repository |
Specific settings for a Python remote repository. |
apt_repository |
Specific settings for an Apt remote repository. |
yum_repository |
Specific settings for a Yum remote repository. |
common_repository |
Common remote repository settings. Used as the remote repository upstream URL. |
AptRepository
Configuration for an Apt remote repository.
| Fields | |
|---|---|
Union field upstream. Address of the remote repository. upstream can be only one of the following: |
|
public_repository |
One of the publicly available Apt repositories supported by Artifact Registry. |
custom_repository |
Customer-specified remote repository. |
CustomRepository
Customer-specified publicly available remote repository.
| Fields | |
|---|---|
uri |
An http/https uri reference to the upstream remote repository, for ex: "https://my.apt.registry/". |
PublicRepository
Publicly available Apt repositories constructed from a common repository base and a custom repository path.
| Fields | |
|---|---|
repository_base |
A common public repository base for Apt. |
repository_path |
A custom field to define a path to a specific repository from the base. |
RepositoryBase
Predefined list of publicly available repository bases for Apt.
| Enums | |
|---|---|
REPOSITORY_BASE_UNSPECIFIED |
Unspecified repository base. |
DEBIAN |
Debian. |
UBUNTU |
Ubuntu LTS/Pro. |
DEBIAN_SNAPSHOT |
Archived Debian. |
CommonRemoteRepository
Common remote repository settings type.
| Fields | |
|---|---|
uri |
Required. A common public repository base for remote repository. |
DockerRepository
Configuration for a Docker remote repository.
| Fields | |
|---|---|
Union field upstream. Address of the remote repository. upstream can be only one of the following: |
|
public_repository |
One of the publicly available Docker repositories supported by Artifact Registry. |
custom_repository |
Customer-specified remote repository. |
CustomRepository
Customer-specified publicly available remote repository.
| Fields | |
|---|---|
uri |
An http/https uri reference to the custom remote repository, for ex: "https://registry-1.docker.io". |
PublicRepository
Predefined list of publicly available Docker repositories like Docker Hub.
| Enums | |
|---|---|
PUBLIC_REPOSITORY_UNSPECIFIED |
Unspecified repository. |
DOCKER_HUB |
Docker Hub. |
MavenRepository
Configuration for a Maven remote repository.
| Fields | |
|---|---|
Union field upstream. Address of the remote repository. upstream can be only one of the following: |
|
public_repository |
One of the publicly available Maven repositories supported by Artifact Registry. |
custom_repository |
Customer-specified remote repository. |
CustomRepository
Customer-specified publicly available remote repository.
| Fields | |
|---|---|
uri |
An http/https uri reference to the upstream remote repository, for ex: "https://my.maven.registry/". |
PublicRepository
Predefined list of publicly available Maven repositories like Maven Central.
| Enums | |
|---|---|
PUBLIC_REPOSITORY_UNSPECIFIED |
Unspecified repository. |
MAVEN_CENTRAL |
Maven Central. |
NpmRepository
Configuration for a Npm remote repository.
| Fields | |
|---|---|
Union field upstream. Address of the remote repository upstream can be only one of the following: |
|
public_repository |
One of the publicly available Npm repositories supported by Artifact Registry. |
custom_repository |
Customer-specified remote repository. |
CustomRepository
Customer-specified publicly available remote repository.
| Fields | |
|---|---|
uri |
An http/https uri reference to the upstream remote repository, for ex: "https://my.npm.registry/". |
PublicRepository
Predefined list of publicly available NPM repositories like npmjs.
| Enums | |
|---|---|
PUBLIC_REPOSITORY_UNSPECIFIED |
Unspecified repository. |
NPMJS |
npmjs. |
PythonRepository
Configuration for a Python remote repository.
| Fields | |
|---|---|
Union field upstream. Address of the remote repository. upstream can be only one of the following: |
|
public_repository |
One of the publicly available Python repositories supported by Artifact Registry. |
custom_repository |
Customer-specified remote repository. |
CustomRepository
Customer-specified publicly available remote repository.
| Fields | |
|---|---|
uri |
An http/https uri reference to the upstream remote repository, for ex: "https://my.python.registry/". |
PublicRepository
Predefined list of publicly available Python repositories like PyPI.org.
| Enums | |
|---|---|
PUBLIC_REPOSITORY_UNSPECIFIED |
Unspecified repository. |
PYPI |
PyPI. |
UpstreamCredentials
The credentials to access the remote repository.
| Fields | |
|---|---|
Union field
|
|
username_password_credentials |
Use username and password to access the remote repository. |
UsernamePasswordCredentials
Username and password credentials.
| Fields | |
|---|---|
username |
The username to access the remote repository. |
password_secret_version |
The Secret Manager key version that holds the password to access the remote repository. Must be in the format of |
YumRepository
Configuration for a Yum remote repository.
| Fields | |
|---|---|
Union field upstream. Address of the remote repository. upstream can be only one of the following: |
|
public_repository |
One of the publicly available Yum repositories supported by Artifact Registry. |
custom_repository |
Customer-specified remote repository. |
CustomRepository
Customer-specified publicly available remote repository.
| Fields | |
|---|---|
uri |
An http/https uri reference to the upstream remote repository, for ex: "https://my.yum.registry/". |
PublicRepository
Publicly available Yum repositories constructed from a common repository base and a custom repository path.
| Fields | |
|---|---|
repository_base |
A common public repository base for Yum. |
repository_path |
A custom field to define a path to a specific repository from the base. |
RepositoryBase
Predefined list of publicly available repository bases for Yum.
| Enums | |
|---|---|
REPOSITORY_BASE_UNSPECIFIED |
Unspecified repository base. |
CENTOS |
CentOS. |
CENTOS_DEBUG |
CentOS Debug. |
CENTOS_VAULT |
CentOS Vault. |
CENTOS_STREAM |
CentOS Stream. |
ROCKY |
Rocky. |
EPEL |
Fedora Extra Packages for Enterprise Linux (EPEL). |
Repository
A Repository for storing artifacts with a specific format.
| Fields | |
|---|---|
name |
The name of the repository, for example: |
format |
Optional. The format of packages that are stored in the repository. |
description |
The user-provided description of the repository. |
labels |
Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes. |
create_time |
Output only. The time when the repository was created. |
update_time |
Output only. The time when the repository was last updated. |
kms_key_name |
The Cloud KMS resource name of the customer managed encryption key that's used to encrypt the contents of the Repository. Has the form: |
mode |
Optional. The mode of the repository. |
cleanup_policies |
Optional. Cleanup policies for this repository. Cleanup policies indicate when certain package versions can be automatically deleted. Map keys are policy IDs supplied by users during policy creation. They must unique within a repository and be under 128 characters in length. |
size_bytes |
Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs. |
satisfies_pzs |
Output only. If set, the repository satisfies physical zone separation. |
cleanup_policy_dry_run |
Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository. |
disallow_unspecified_mode |
Optional. If this is true, an unspecified repo type will be treated as error rather than defaulting to standard. |
satisfies_pzi |
Output only. If set, the repository satisfies physical zone isolation. |
Union field format_config. Repository-specific configurations. format_config can be only one of the following: |
|
maven_config |
Maven repository config contains repository level configuration for the repositories of maven type. |
docker_config |
Docker repository config contains repository level configuration for the repositories of docker type. |
Union field mode_config. Repository configuration specific to the Mode value being selected (Remote or Virtual) mode_config can be only one of the following: |
|
virtual_repository_config |
Configuration specific for a Virtual Repository. |
remote_repository_config |
Configuration specific for a Remote Repository. |
DockerRepositoryConfig
DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type.
| Fields | |
|---|---|
immutable_tags |
The repository which enabled this flag prevents all tags from being modified, moved or deleted. This does not prevent tags from being created. |
Format
A package format.
| Enums | |
|---|---|
FORMAT_UNSPECIFIED |
Unspecified package format. |
DOCKER |
Docker package format. |
MAVEN |
Maven package format. |
NPM |
NPM package format. |
APT |
APT package format. |
YUM |
YUM package format. |
GOOGET |
GooGet package format. |
PYTHON |
Python package format. |
KFP |
Kubeflow Pipelines package format. |
GO |
Go package format. |
GENERIC |
Generic package format. |
MavenRepositoryConfig
MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type.
| Fields | |
|---|---|
allow_snapshot_overwrites |
The repository with this flag will allow publishing the same snapshot versions. |
version_policy |
Version policy defines the versions that the registry will accept. |
VersionPolicy
VersionPolicy is the version policy for the repository.
| Enums | |
|---|---|
VERSION_POLICY_UNSPECIFIED |
VERSION_POLICY_UNSPECIFIED - the version policy is not defined. When the version policy is not defined, no validation is performed for the versions. |
RELEASE |
RELEASE - repository will accept only Release versions. |
SNAPSHOT |
SNAPSHOT - repository will accept only Snapshot versions. |
Mode
The mode configures the repository to serve artifacts from different sources.
| Enums | |
|---|---|
MODE_UNSPECIFIED |
Unspecified mode. |
STANDARD_REPOSITORY |
A standard repository storing artifacts. |
VIRTUAL_REPOSITORY |
A virtual repository to serve artifacts from one or more sources. |
REMOTE_REPOSITORY |
A remote repository to serve artifacts from a remote source. |
ASSURED_OSS_REPOSITORY |
Replacement of AOSS_REPOSITORY. |
Rule
A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within.
| Fields | |
|---|---|
name |
The name of the rule, for example: |
action |
The action this rule takes. |
operation |
|
condition |
Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects. |
package_id |
The package ID the rule applies to. If empty, this rule applies to all packages inside the repository. |
Action
Defines the action of the rule.
| Enums | |
|---|---|
ACTION_UNSPECIFIED |
Action not specified. |
ALLOW |
Allow the operation. |
DENY |
Deny the operation. |
Operation
The operation the rule applies to.
| Enums | |
|---|---|
OPERATION_UNSPECIFIED |
Operation not specified. |
DOWNLOAD |
Download operation. |
Tag
Tags point to a version and represent an alternative name that can be used to access the version.
| Fields | |
|---|---|
name |
The name of the tag, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9-._~:@], anything else must be URL encoded. |
version |
The name of the version the tag refers to, for example: |
UpdateFileRequest
The request to update a file.
| Fields | |
|---|---|
file |
Required. The File that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. The update mask applies to the resource. For the |
UpdatePackageRequest
The request to update a package.
| Fields | |
|---|---|
package |
The package that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UpdateProjectSettingsRequest
Sets the settings of the project.
| Fields | |
|---|---|
project_settings |
The project settings. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Field mask to support partial updates. |
UpdateRepositoryRequest
The request to update a repository.
| Fields | |
|---|---|
repository |
The repository that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UpdateRuleRequest
The request to update a rule.
| Fields | |
|---|---|
rule |
The rule that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UpdateTagRequest
The request to create or update a tag.
| Fields | |
|---|---|
tag |
The tag that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UpdateVPCSCConfigRequest
Sets the VPCSC config of the project.
| Fields | |
|---|---|
vpcsc_config |
The project config. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Field mask to support partial updates. |
UpdateVersionRequest
The request to update a version.
| Fields | |
|---|---|
version |
Required. The Version that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UploadAptArtifactMetadata
This type has no fields.
The operation metadata for uploading artifacts.
UploadAptArtifactResponse
The response of the completed artifact upload operation. This response is contained in the Operation and available to users.
| Fields | |
|---|---|
apt_artifacts[] |
The Apt artifacts updated. |
UploadFileMetadata
This type has no fields.
The operation metadata for uploading files.
UploadGenericArtifactMetadata
This type has no fields.
The operation metadata for uploading generic artifacts.
UploadGoModuleMetadata
This type has no fields.
The operation metadata for uploading go modules.
UploadGoogetArtifactMetadata
This type has no fields.
The operation metadata for uploading artifacts.
UploadGoogetArtifactResponse
The response of the completed artifact upload operation. This response is contained in the Operation and available to users.
| Fields | |
|---|---|
googet_artifacts[] |
The GooGet artifacts updated. |
UploadKfpArtifactMetadata
This type has no fields.
The operation metadata for uploading KFP artifacts.
UploadYumArtifactMetadata
This type has no fields.
The operation metadata for uploading artifacts.
UploadYumArtifactResponse
The response of the completed artifact upload operation. This response is contained in the Operation and available to users.
| Fields | |
|---|---|
yum_artifacts[] |
The Yum artifacts updated. |
UpstreamPolicy
Artifact policy configuration for the repository contents.
| Fields | |
|---|---|
id |
The user-provided ID of the upstream policy. |
repository |
A reference to the repository resource, for example: |
priority |
Entries with a greater priority value take precedence in the pull order. |
VPCSCConfig
The Artifact Registry VPC SC config that apply to a Project.
| Fields | |
|---|---|
name |
The name of the project's VPC SC Config. Always of the form: projects/{projectID}/locations/{location}/vpcscConfig In update request: never set In response: always set |
vpcsc_policy |
The project per location VPC SC policy that defines the VPC SC behavior for the Remote Repository (Allow/Deny). |
VPCSCPolicy
VPCSCPolicy is the VPC SC policy for project and location.
| Enums | |
|---|---|
VPCSC_POLICY_UNSPECIFIED |
VPCSC_POLICY_UNSPECIFIED - the VPS SC policy is not defined. When VPS SC policy is not defined - the Service will use the default behavior (VPCSC_DENY). |
DENY |
VPCSC_DENY - repository will block the requests to the Upstreams for the Remote Repositories if the resource is in the perimeter. |
ALLOW |
VPCSC_ALLOW - repository will allow the requests to the Upstreams for the Remote Repositories if the resource is in the perimeter. |
Version
The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes.
| Fields | |
|---|---|
name |
The name of the version, for example: |
description |
Optional. Description of the version, as specified in its metadata. |
create_time |
The time when the version was created. |
update_time |
The time when the version was last updated. |
related_tags[] |
Output only. A list of related tags. Will contain up to 100 tags that reference this version. |
metadata |
Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: |
annotations |
Optional. Client specified annotations. |
VersionView
The view, which determines what version information is returned in a response.
| Enums | |
|---|---|
VERSION_VIEW_UNSPECIFIED |
The default / unset value. The API will default to the BASIC view. |
BASIC |
Includes basic information about the version, but not any related tags. |
FULL |
Include everything. |
VirtualRepositoryConfig
Virtual repository configuration.
| Fields | |
|---|---|
upstream_policies[] |
Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository. |
YumArtifact
A detailed representation of a Yum artifact.
| Fields | |
|---|---|
name |
Output only. The Artifact Registry resource name of the artifact. |
package_name |
Output only. The yum package name of the artifact. |
package_type |
Output only. An artifact is a binary or source package. |
architecture |
Output only. Operating system architecture of the artifact. |
PackageType
Package type is either binary or source.
| Enums | |
|---|---|
PACKAGE_TYPE_UNSPECIFIED |
Package type is not specified. |
BINARY |
Binary package (.rpm). |
SOURCE |
Source package (.srpm). |