Class ArtifactRegistryClient (2.29.0-rc)

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.
Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ArtifactRegistryClient(ArtifactRegistryClient const &)

Copy and move support

Parameter
Name Description
ArtifactRegistryClient const &

ArtifactRegistryClient(ArtifactRegistryClient &&)

Copy and move support

Parameter
Name Description
ArtifactRegistryClient &&

ArtifactRegistryClient(std::shared_ptr< ArtifactRegistryConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< ArtifactRegistryConnection >
opts Options

Operators

operator=(ArtifactRegistryClient const &)

Copy and move support

Parameter
Name Description
ArtifactRegistryClient const &
Returns
Type Description
ArtifactRegistryClient &

operator=(ArtifactRegistryClient &&)

Copy and move support

Parameter
Name Description
ArtifactRegistryClient &&
Returns
Type Description
ArtifactRegistryClient &

Functions

ListDockerImages(std::string const &, Options)

Lists docker images.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource whose docker images will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::DockerImage >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.DockerImage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDockerImages(google::devtools::artifactregistry::v1::ListDockerImagesRequest, Options)

Lists docker images.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListDockerImagesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListDockerImagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::DockerImage >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.DockerImage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDockerImage(std::string const &, Options)

Gets a docker image.

Parameters
Name Description
name std::string const &

Required. The name of the docker images.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::DockerImage >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.DockerImage) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDockerImage(google::devtools::artifactregistry::v1::GetDockerImageRequest const &, Options)

Gets a docker image.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetDockerImageRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetDockerImageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::DockerImage >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.DockerImage) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMavenArtifacts(std::string const &, Options)

Lists maven artifacts.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource whose maven artifacts will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::MavenArtifact >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.MavenArtifact, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMavenArtifacts(google::devtools::artifactregistry::v1::ListMavenArtifactsRequest, Options)

Lists maven artifacts.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListMavenArtifactsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListMavenArtifactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::MavenArtifact >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.MavenArtifact, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetMavenArtifact(std::string const &, Options)

Gets a maven artifact.

Parameters
Name Description
name std::string const &

Required. The name of the maven artifact.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::MavenArtifact >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.MavenArtifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMavenArtifact(google::devtools::artifactregistry::v1::GetMavenArtifactRequest const &, Options)

Gets a maven artifact.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetMavenArtifactRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetMavenArtifactRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::MavenArtifact >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.MavenArtifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListNpmPackages(std::string const &, Options)

Lists npm packages.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource whose npm packages will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::NpmPackage >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.NpmPackage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNpmPackages(google::devtools::artifactregistry::v1::ListNpmPackagesRequest, Options)

Lists npm packages.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListNpmPackagesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListNpmPackagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::NpmPackage >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.NpmPackage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetNpmPackage(std::string const &, Options)

Gets a npm package.

Parameters
Name Description
name std::string const &

Required. The name of the npm package.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::NpmPackage >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.NpmPackage) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNpmPackage(google::devtools::artifactregistry::v1::GetNpmPackageRequest const &, Options)

Gets a npm package.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetNpmPackageRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetNpmPackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::NpmPackage >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.NpmPackage) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListPythonPackages(std::string const &, Options)

Lists python packages.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource whose python packages will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::PythonPackage >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.PythonPackage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPythonPackages(google::devtools::artifactregistry::v1::ListPythonPackagesRequest, Options)

Lists python packages.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListPythonPackagesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListPythonPackagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::PythonPackage >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.PythonPackage, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetPythonPackage(std::string const &, Options)

Gets a python package.

Parameters
Name Description
name std::string const &

Required. The name of the python package.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::PythonPackage >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.PythonPackage) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPythonPackage(google::devtools::artifactregistry::v1::GetPythonPackageRequest const &, Options)

Gets a python package.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetPythonPackageRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetPythonPackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::PythonPackage >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.PythonPackage) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportAptArtifacts(google::devtools::artifactregistry::v1::ImportAptArtifactsRequest const &, Options)

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.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ImportAptArtifactsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ImportAptArtifactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::ImportAptArtifactsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.ImportAptArtifactsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportAptArtifacts(NoAwaitTag, google::devtools::artifactregistry::v1::ImportAptArtifactsRequest const &, Options)

Imports Apt artifacts.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::ImportAptArtifactsRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ImportAptArtifacts(google::longrunning::Operation const &, Options)

Imports Apt artifacts.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::ImportAptArtifactsResponse > >

ImportYumArtifacts(google::devtools::artifactregistry::v1::ImportYumArtifactsRequest const &, Options)

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.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ImportYumArtifactsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ImportYumArtifactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::ImportYumArtifactsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.ImportYumArtifactsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportYumArtifacts(NoAwaitTag, google::devtools::artifactregistry::v1::ImportYumArtifactsRequest const &, Options)

Imports Yum (RPM) artifacts.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::ImportYumArtifactsRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ImportYumArtifacts(google::longrunning::Operation const &, Options)

Imports Yum (RPM) artifacts.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::ImportYumArtifactsResponse > >

ListRepositories(std::string const &, Options)

Lists repositories.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource whose repositories will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Repository >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Repository, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRepositories(google::devtools::artifactregistry::v1::ListRepositoriesRequest, Options)

Lists repositories.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListRepositoriesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListRepositoriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Repository >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Repository, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetRepository(std::string const &, Options)

Gets a repository.

Parameters
Name Description
name std::string const &

Required. The name of the repository to retrieve.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Repository >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRepository(google::devtools::artifactregistry::v1::GetRepositoryRequest const &, Options)

Gets a repository.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetRepositoryRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Repository >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateRepository(std::string const &, google::devtools::artifactregistry::v1::Repository const &, std::string const &, Options)

Creates a repository.

The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource where the repository will be created.

repository google::devtools::artifactregistry::v1::Repository const &

Required. The repository to be created.

repository_id std::string const &

Required. The repository id to use for this repository.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::Repository > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.Repository proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRepository(NoAwaitTag, std::string const &, google::devtools::artifactregistry::v1::Repository const &, std::string const &, Options)

Creates a repository.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
repository google::devtools::artifactregistry::v1::Repository const &
repository_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateRepository(google::devtools::artifactregistry::v1::CreateRepositoryRequest const &, Options)

Creates a repository.

The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Parameters
Name Description
request google::devtools::artifactregistry::v1::CreateRepositoryRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.CreateRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::Repository > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.Repository proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateRepository(NoAwaitTag, google::devtools::artifactregistry::v1::CreateRepositoryRequest const &, Options)

Creates a repository.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::CreateRepositoryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateRepository(google::longrunning::Operation const &, Options)

Creates a repository.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::Repository > >

UpdateRepository(google::devtools::artifactregistry::v1::Repository const &, google::protobuf::FieldMask const &, Options)

Updates a repository.

Parameters
Name Description
repository google::devtools::artifactregistry::v1::Repository const &

The repository that replaces the resource on the server.

update_mask google::protobuf::FieldMask const &

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Repository >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRepository(google::devtools::artifactregistry::v1::UpdateRepositoryRequest const &, Options)

Updates a repository.

Parameters
Name Description
request google::devtools::artifactregistry::v1::UpdateRepositoryRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.UpdateRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Repository >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Repository) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteRepository(std::string const &, Options)

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.

Parameters
Name Description
name std::string const &

Required. The name of the repository to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRepository(NoAwaitTag, std::string const &, Options)

Deletes a repository and all of its contents.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRepository(google::devtools::artifactregistry::v1::DeleteRepositoryRequest const &, Options)

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.

Parameters
Name Description
request google::devtools::artifactregistry::v1::DeleteRepositoryRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.DeleteRepositoryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRepository(NoAwaitTag, google::devtools::artifactregistry::v1::DeleteRepositoryRequest const &, Options)

Deletes a repository and all of its contents.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::DeleteRepositoryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRepository(google::longrunning::Operation const &, Options)

Deletes a repository and all of its contents.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

ListPackages(std::string const &, Options)

Lists packages.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource whose packages will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Package >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Package, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPackages(google::devtools::artifactregistry::v1::ListPackagesRequest, Options)

Lists packages.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListPackagesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListPackagesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Package >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Package, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetPackage(std::string const &, Options)

Gets a package.

Parameters
Name Description
name std::string const &

Required. The name of the package to retrieve.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Package >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Package) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPackage(google::devtools::artifactregistry::v1::GetPackageRequest const &, Options)

Gets a package.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetPackageRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetPackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Package >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Package) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeletePackage(std::string const &, Options)

Deletes a package and all of its versions and tags.

The returned operation will complete once the package has been deleted.

Parameters
Name Description
name std::string const &

Required. The name of the package to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePackage(NoAwaitTag, std::string const &, Options)

Deletes a package and all of its versions and tags.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeletePackage(google::devtools::artifactregistry::v1::DeletePackageRequest const &, Options)

Deletes a package and all of its versions and tags.

The returned operation will complete once the package has been deleted.

Parameters
Name Description
request google::devtools::artifactregistry::v1::DeletePackageRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.DeletePackageRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePackage(NoAwaitTag, google::devtools::artifactregistry::v1::DeletePackageRequest const &, Options)

Deletes a package and all of its versions and tags.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::DeletePackageRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeletePackage(google::longrunning::Operation const &, Options)

Deletes a package and all of its versions and tags.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

ListVersions(std::string const &, Options)

Lists versions.

Parameters
Name Description
parent std::string const &

The name of the parent resource whose versions will be listed.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Version >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Version, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListVersions(google::devtools::artifactregistry::v1::ListVersionsRequest, Options)

Lists versions.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListVersionsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListVersionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Version >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Version, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetVersion(std::string const &, Options)

Gets a version.

Parameters
Name Description
name std::string const &

The name of the version to retrieve.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Version >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetVersion(google::devtools::artifactregistry::v1::GetVersionRequest const &, Options)

Gets a version.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetVersionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Version >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteVersion(std::string const &, Options)

Deletes a version and all of its content.

The returned operation will complete once the version has been deleted.

Parameters
Name Description
name std::string const &

The name of the version to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVersion(NoAwaitTag, std::string const &, Options)

Deletes a version and all of its content.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteVersion(google::devtools::artifactregistry::v1::DeleteVersionRequest const &, Options)

Deletes a version and all of its content.

The returned operation will complete once the version has been deleted.

Parameters
Name Description
request google::devtools::artifactregistry::v1::DeleteVersionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.DeleteVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteVersion(NoAwaitTag, google::devtools::artifactregistry::v1::DeleteVersionRequest const &, Options)

Deletes a version and all of its content.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::DeleteVersionRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteVersion(google::longrunning::Operation const &, Options)

Deletes a version and all of its content.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::OperationMetadata > >

BatchDeleteVersions(std::string const &, std::vector< std::string > const &, Options)

Deletes multiple versions across a repository.

The returned operation will complete once the versions have been deleted.

Parameters
Name Description
parent std::string const &

The name of the repository holding all requested versions.

names std::vector< std::string > const &

Required. The names of the versions to delete. A maximum of 10000 versions can be deleted in a batch.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::BatchDeleteVersionsMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.BatchDeleteVersionsMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteVersions(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)

Deletes multiple versions across a repository.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
names std::vector< std::string > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteVersions(google::devtools::artifactregistry::v1::BatchDeleteVersionsRequest const &, Options)

Deletes multiple versions across a repository.

The returned operation will complete once the versions have been deleted.

Parameters
Name Description
request google::devtools::artifactregistry::v1::BatchDeleteVersionsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.BatchDeleteVersionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::BatchDeleteVersionsMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.devtools.artifactregistry.v1.BatchDeleteVersionsMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchDeleteVersions(NoAwaitTag, google::devtools::artifactregistry::v1::BatchDeleteVersionsRequest const &, Options)

Deletes multiple versions across a repository.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::devtools::artifactregistry::v1::BatchDeleteVersionsRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchDeleteVersions(google::longrunning::Operation const &, Options)

Deletes multiple versions across a repository.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::devtools::artifactregistry::v1::BatchDeleteVersionsMetadata > >

ListFiles(std::string const &, Options)

Lists files.

Parameters
Name Description
parent std::string const &

Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1"

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::File >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.File, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFiles(google::devtools::artifactregistry::v1::ListFilesRequest, Options)

Lists files.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListFilesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListFilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::File >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.File, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetFile(std::string const &, Options)

Gets a file.

Parameters
Name Description
name std::string const &

Required. The name of the file to retrieve.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::File >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.File) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetFile(google::devtools::artifactregistry::v1::GetFileRequest const &, Options)

Gets a file.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetFileRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetFileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::File >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.File) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListTags(std::string const &, Options)

Lists tags.

Parameters
Name Description
parent std::string const &

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Tag >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Tag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTags(google::devtools::artifactregistry::v1::ListTagsRequest, Options)

Lists tags.

Parameters
Name Description
request google::devtools::artifactregistry::v1::ListTagsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.ListTagsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::devtools::artifactregistry::v1::Tag >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.devtools.artifactregistry.v1.Tag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetTag(std::string const &, Options)

Gets a tag.

Parameters
Name Description
name std::string const &

The name of the tag to retrieve.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Tag >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTag(google::devtools::artifactregistry::v1::GetTagRequest const &, Options)

Gets a tag.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetTagRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Tag >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTag(std::string const &, google::devtools::artifactregistry::v1::Tag const &, std::string const &, Options)

Creates a tag.

Parameters
Name Description
parent std::string const &

The name of the parent resource where the tag will be created.

tag google::devtools::artifactregistry::v1::Tag const &

The tag to be created.

tag_id std::string const &

The tag id to use for this repository.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Tag >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTag(google::devtools::artifactregistry::v1::CreateTagRequest const &, Options)

Creates a tag.

Parameters
Name Description
request google::devtools::artifactregistry::v1::CreateTagRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.CreateTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Tag >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTag(google::devtools::artifactregistry::v1::Tag const &, google::protobuf::FieldMask const &, Options)

Updates a tag.

Parameters
Name Description
tag google::devtools::artifactregistry::v1::Tag const &

The tag that replaces the resource on the server.

update_mask google::protobuf::FieldMask const &

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Tag >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTag(google::devtools::artifactregistry::v1::UpdateTagRequest const &, Options)

Updates a tag.

Parameters
Name Description
request google::devtools::artifactregistry::v1::UpdateTagRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.UpdateTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::Tag >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteTag(std::string const &, Options)

Deletes a tag.

Parameters
Name Description
name std::string const &

The name of the tag to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteTag(google::devtools::artifactregistry::v1::DeleteTagRequest const &, Options)

Deletes a tag.

Parameters
Name Description
request google::devtools::artifactregistry::v1::DeleteTagRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.DeleteTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Updates the IAM policy for a given resource.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the IAM policy for a given resource.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::Policy >

the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Tests if the caller has a list of permissions on a resource.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetProjectSettings(std::string const &, Options)

Retrieves the Settings for the Project.

Parameters
Name Description
name std::string const &

Required. The name of the projectSettings resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::ProjectSettings >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.ProjectSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetProjectSettings(google::devtools::artifactregistry::v1::GetProjectSettingsRequest const &, Options)

Retrieves the Settings for the Project.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetProjectSettingsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetProjectSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::ProjectSettings >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.ProjectSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateProjectSettings(google::devtools::artifactregistry::v1::ProjectSettings const &, google::protobuf::FieldMask const &, Options)

Updates the Settings for the Project.

Parameters
Name Description
project_settings google::devtools::artifactregistry::v1::ProjectSettings const &

The project settings.

update_mask google::protobuf::FieldMask const &

Field mask to support partial updates.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::ProjectSettings >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.ProjectSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateProjectSettings(google::devtools::artifactregistry::v1::UpdateProjectSettingsRequest const &, Options)

Updates the Settings for the Project.

Parameters
Name Description
request google::devtools::artifactregistry::v1::UpdateProjectSettingsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.UpdateProjectSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::ProjectSettings >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.ProjectSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetVPCSCConfig(std::string const &, Options)

Retrieves the VPCSC Config for the Project.

Parameters
Name Description
name std::string const &

Required. The name of the VPCSCConfig resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::VPCSCConfig >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.VPCSCConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetVPCSCConfig(google::devtools::artifactregistry::v1::GetVPCSCConfigRequest const &, Options)

Retrieves the VPCSC Config for the Project.

Parameters
Name Description
request google::devtools::artifactregistry::v1::GetVPCSCConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.GetVPCSCConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::VPCSCConfig >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.VPCSCConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateVPCSCConfig(google::devtools::artifactregistry::v1::VPCSCConfig const &, google::protobuf::FieldMask const &, Options)

Updates the VPCSC Config for the Project.

Parameters
Name Description
vpcsc_config google::devtools::artifactregistry::v1::VPCSCConfig const &

The project config.

update_mask google::protobuf::FieldMask const &

Field mask to support partial updates.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::VPCSCConfig >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.VPCSCConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateVPCSCConfig(google::devtools::artifactregistry::v1::UpdateVPCSCConfigRequest const &, Options)

Updates the VPCSC Config for the Project.

Parameters
Name Description
request google::devtools::artifactregistry::v1::UpdateVPCSCConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.devtools.artifactregistry.v1.UpdateVPCSCConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::devtools::artifactregistry::v1::VPCSCConfig >

the result of the RPC. The response message type (google.devtools.artifactregistry.v1.VPCSCConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.