Artifact Registry V1 API - Class Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client (v0.12.0)

Reference documentation and code samples for the Artifact Registry V1 API class Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.

REST client for the ArtifactRegistry service.

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.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ArtifactRegistry Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ArtifactRegistry clients
::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#batch_delete_versions

def batch_delete_versions(request, options = nil) -> ::Gapic::Operation
def batch_delete_versions(parent: nil, names: nil, validate_only: nil) -> ::Gapic::Operation

Deletes multiple versions across a repository. The returned operation will complete once the versions have been deleted.

Overloads 
def batch_delete_versions(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_delete_versions via a request object, either of type BatchDeleteVersionsRequest or an equivalent Hash.
Parameters 
def batch_delete_versions(parent: nil, names: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to batch_delete_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — The name of the repository holding all requested versions.
  • names (::Array<::String>) — Required. The names of the versions to delete. A maximum of 10000 versions can be deleted in a batch.
  • validate_only (::Boolean) — If true, the request is performed without deleting data, following AIP-163.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::BatchDeleteVersionsRequest.new

# Call the batch_delete_versions method.
result = client.batch_delete_versions request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ArtifactRegistry Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_repository

def create_repository(request, options = nil) -> ::Gapic::Operation
def create_repository(parent: nil, repository_id: nil, repository: nil) -> ::Gapic::Operation

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

Overloads 
def create_repository(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_repository via a request object, either of type CreateRepositoryRequest or an equivalent Hash.
Parameters 
def create_repository(parent: nil, repository_id: nil, repository: nil) -> ::Gapic::Operation
Pass arguments to create_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource where the repository will be created.
  • repository_id (::String) — Required. The repository id to use for this repository.
  • repository (::Google::Cloud::ArtifactRegistry::V1::Repository, ::Hash) — Required. The repository to be created.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::CreateRepositoryRequest.new

# Call the create_repository method.
result = client.create_repository request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_tag

def create_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
def create_tag(parent: nil, tag_id: nil, tag: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag

Creates a tag.

Overloads 
def create_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Pass arguments to create_tag via a request object, either of type CreateTagRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::CreateTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_tag(parent: nil, tag_id: nil, tag: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Pass arguments to create_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::CreateTagRequest.new

# Call the create_tag method.
result = client.create_tag request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Tag.
p result

#delete_package

def delete_package(request, options = nil) -> ::Gapic::Operation
def delete_package(name: nil) -> ::Gapic::Operation

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Overloads 
def delete_package(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_package via a request object, either of type DeletePackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::DeletePackageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_package(name: nil) -> ::Gapic::Operation
Pass arguments to delete_package via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the package to delete.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::DeletePackageRequest.new

# Call the delete_package method.
result = client.delete_package request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_repository

def delete_repository(request, options = nil) -> ::Gapic::Operation
def delete_repository(name: nil) -> ::Gapic::Operation

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.

Overloads 
def delete_repository(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_repository via a request object, either of type DeleteRepositoryRequest or an equivalent Hash.
Parameters 
def delete_repository(name: nil) -> ::Gapic::Operation
Pass arguments to delete_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the repository to delete.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::DeleteRepositoryRequest.new

# Call the delete_repository method.
result = client.delete_repository request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_tag

def delete_tag(request, options = nil) -> ::Google::Protobuf::Empty
def delete_tag(name: nil) -> ::Google::Protobuf::Empty

Deletes a tag.

Overloads 
def delete_tag(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tag via a request object, either of type DeleteTagRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::DeleteTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_tag(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — The name of the tag to delete.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::DeleteTagRequest.new

# Call the delete_tag method.
result = client.delete_tag request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_version

def delete_version(request, options = nil) -> ::Gapic::Operation
def delete_version(name: nil, force: nil) -> ::Gapic::Operation

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Overloads 
def delete_version(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_version via a request object, either of type DeleteVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::DeleteVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_version(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — The name of the version to delete.
  • force (::Boolean) — 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::DeleteVersionRequest.new

# Call the delete_version method.
result = client.delete_version request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_docker_image

def get_docker_image(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
def get_docker_image(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage

Gets a docker image.

Overloads 
def get_docker_image(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
Pass arguments to get_docker_image via a request object, either of type GetDockerImageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetDockerImageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_docker_image(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
Pass arguments to get_docker_image via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the docker images.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetDockerImageRequest.new

# Call the get_docker_image method.
result = client.get_docker_image request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::DockerImage.
p result

#get_file

def get_file(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
def get_file(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::File

Gets a file.

Overloads 
def get_file(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
Pass arguments to get_file via a request object, either of type GetFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_file(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
Pass arguments to get_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the file to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetFileRequest.new

# Call the get_file method.
result = client.get_file request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::File.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the IAM policy for a given resource.

Overloads 
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

# Call the get_iam_policy method.
result = client.get_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#get_maven_artifact

def get_maven_artifact(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::MavenArtifact
def get_maven_artifact(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::MavenArtifact

Gets a maven artifact.

Overloads 
def get_maven_artifact(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::MavenArtifact
Pass arguments to get_maven_artifact via a request object, either of type GetMavenArtifactRequest or an equivalent Hash.
Parameters 
def get_maven_artifact(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::MavenArtifact
Pass arguments to get_maven_artifact via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the maven artifact.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetMavenArtifactRequest.new

# Call the get_maven_artifact method.
result = client.get_maven_artifact request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::MavenArtifact.
p result

#get_npm_package

def get_npm_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::NpmPackage
def get_npm_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::NpmPackage

Gets a npm package.

Overloads 
def get_npm_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::NpmPackage
Pass arguments to get_npm_package via a request object, either of type GetNpmPackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetNpmPackageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_npm_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::NpmPackage
Pass arguments to get_npm_package via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the npm package.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetNpmPackageRequest.new

# Call the get_npm_package method.
result = client.get_npm_package request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::NpmPackage.
p result

#get_package

def get_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
def get_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package

Gets a package.

Overloads 
def get_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
Pass arguments to get_package via a request object, either of type GetPackageRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetPackageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
Pass arguments to get_package via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the package to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetPackageRequest.new

# Call the get_package method.
result = client.get_package request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Package.
p result

#get_project_settings

def get_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
def get_project_settings(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings

Retrieves the Settings for the Project.

Overloads 
def get_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
Pass arguments to get_project_settings via a request object, either of type GetProjectSettingsRequest or an equivalent Hash.
Parameters 
def get_project_settings(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
Pass arguments to get_project_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the projectSettings resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetProjectSettingsRequest.new

# Call the get_project_settings method.
result = client.get_project_settings request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::ProjectSettings.
p result

#get_python_package

def get_python_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::PythonPackage
def get_python_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::PythonPackage

Gets a python package.

Overloads 
def get_python_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::PythonPackage
Pass arguments to get_python_package via a request object, either of type GetPythonPackageRequest or an equivalent Hash.
Parameters 
def get_python_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::PythonPackage
Pass arguments to get_python_package via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the python package.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetPythonPackageRequest.new

# Call the get_python_package method.
result = client.get_python_package request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::PythonPackage.
p result

#get_repository

def get_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
def get_repository(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository

Gets a repository.

Overloads 
def get_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
Pass arguments to get_repository via a request object, either of type GetRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_repository(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
Pass arguments to get_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the repository to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetRepositoryRequest.new

# Call the get_repository method.
result = client.get_repository request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Repository.
p result

#get_tag

def get_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
def get_tag(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag

Gets a tag.

Overloads 
def get_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Pass arguments to get_tag via a request object, either of type GetTagRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_tag(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Pass arguments to get_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — The name of the tag to retrieve.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetTagRequest.new

# Call the get_tag method.
result = client.get_tag request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Tag.
p result

#get_version

def get_version(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
def get_version(name: nil, view: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version

Gets a version

Overloads 
def get_version(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
Pass arguments to get_version via a request object, either of type GetVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_version(name: nil, view: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
Pass arguments to get_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetVersionRequest.new

# Call the get_version method.
result = client.get_version request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Version.
p result

#get_vpcsc_config

def get_vpcsc_config(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig
def get_vpcsc_config(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig

Retrieves the VPCSC Config for the Project.

Overloads 
def get_vpcsc_config(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig
Pass arguments to get_vpcsc_config via a request object, either of type GetVPCSCConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::GetVPCSCConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_vpcsc_config(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig
Pass arguments to get_vpcsc_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the VPCSCConfig resource.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::GetVPCSCConfigRequest.new

# Call the get_vpcsc_config method.
result = client.get_vpcsc_config request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::VPCSCConfig.
p result

#import_apt_artifacts

def import_apt_artifacts(request, options = nil) -> ::Gapic::Operation
def import_apt_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation

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.

Overloads 
def import_apt_artifacts(request, options = nil) -> ::Gapic::Operation
Pass arguments to import_apt_artifacts via a request object, either of type ImportAptArtifactsRequest or an equivalent Hash.
Parameters 
def import_apt_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation
Pass arguments to import_apt_artifacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ImportAptArtifactsRequest.new

# Call the import_apt_artifacts method.
result = client.import_apt_artifacts request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#import_yum_artifacts

def import_yum_artifacts(request, options = nil) -> ::Gapic::Operation
def import_yum_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation

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.

Overloads 
def import_yum_artifacts(request, options = nil) -> ::Gapic::Operation
Pass arguments to import_yum_artifacts via a request object, either of type ImportYumArtifactsRequest or an equivalent Hash.
Parameters 
def import_yum_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation
Pass arguments to import_yum_artifacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsRequest.new

# Call the import_yum_artifacts method.
result = client.import_yum_artifacts request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#initialize

def initialize() { |config| ... } -> Client

Create a new ArtifactRegistry REST client object.

Yields
  • (config) — Configure the ArtifactRegistry client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_docker_images

def list_docker_images(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
def list_docker_images(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>

Lists docker images.

Overloads 
def list_docker_images(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
Pass arguments to list_docker_images via a request object, either of type ListDockerImagesRequest or an equivalent Hash.
Parameters 
def list_docker_images(parent: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
Pass arguments to list_docker_images via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource whose docker images will be listed.
  • page_size (::Integer) — The maximum number of artifacts to return.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
  • order_by (::String) — The field to order the results by.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListDockerImagesRequest.new

# Call the list_docker_images method.
result = client.list_docker_images request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::DockerImage.
  p item
end

#list_files

def list_files(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
def list_files(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>

Lists files.

Overloads 
def list_files(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
Pass arguments to list_files via a request object, either of type ListFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::ListFilesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_files(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
Pass arguments to list_files via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
  • filter (::String) —

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • name
    • owner

    An example of using a filter:

    • name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*" --> Files with an ID starting with "a/b/".
    • owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" --> Files owned by the version 1.0 in package pkg1.
  • page_size (::Integer) — The maximum number of files to return.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
  • order_by (::String) — The field to order the results by.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListFilesRequest.new

# Call the list_files method.
result = client.list_files request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::File.
  p item
end

#list_maven_artifacts

def list_maven_artifacts(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::MavenArtifact>
def list_maven_artifacts(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::MavenArtifact>

Lists maven artifacts.

Overloads 
def list_maven_artifacts(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::MavenArtifact>
Pass arguments to list_maven_artifacts via a request object, either of type ListMavenArtifactsRequest or an equivalent Hash.
Parameters 
def list_maven_artifacts(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::MavenArtifact>
Pass arguments to list_maven_artifacts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource whose maven artifacts will be listed.
  • page_size (::Integer) — The maximum number of artifacts to return.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListMavenArtifactsRequest.new

# Call the list_maven_artifacts method.
result = client.list_maven_artifacts request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::MavenArtifact.
  p item
end

#list_npm_packages

def list_npm_packages(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::NpmPackage>
def list_npm_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::NpmPackage>

Lists npm packages.

Overloads 
def list_npm_packages(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::NpmPackage>
Pass arguments to list_npm_packages via a request object, either of type ListNpmPackagesRequest or an equivalent Hash.
Parameters 
def list_npm_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::NpmPackage>
Pass arguments to list_npm_packages via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource whose npm packages will be listed.
  • page_size (::Integer) — The maximum number of artifacts to return.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListNpmPackagesRequest.new

# Call the list_npm_packages method.
result = client.list_npm_packages request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::NpmPackage.
  p item
end

#list_packages

def list_packages(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
def list_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>

Lists packages.

Overloads 
def list_packages(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
Pass arguments to list_packages via a request object, either of type ListPackagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
Pass arguments to list_packages via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource whose packages will be listed.
  • page_size (::Integer) — The maximum number of packages to return. Maximum page size is 1,000.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest.new

# Call the list_packages method.
result = client.list_packages request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Package.
  p item
end

#list_python_packages

def list_python_packages(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::PythonPackage>
def list_python_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::PythonPackage>

Lists python packages.

Overloads 
def list_python_packages(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::PythonPackage>
Pass arguments to list_python_packages via a request object, either of type ListPythonPackagesRequest or an equivalent Hash.
Parameters 
def list_python_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::PythonPackage>
Pass arguments to list_python_packages via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource whose python packages will be listed.
  • page_size (::Integer) — The maximum number of artifacts to return.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListPythonPackagesRequest.new

# Call the list_python_packages method.
result = client.list_python_packages request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::PythonPackage.
  p item
end

#list_repositories

def list_repositories(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
def list_repositories(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>

Lists repositories.

Overloads 
def list_repositories(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
Pass arguments to list_repositories via a request object, either of type ListRepositoriesRequest or an equivalent Hash.
Parameters 
def list_repositories(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
Pass arguments to list_repositories via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent resource whose repositories will be listed.
  • page_size (::Integer) — The maximum number of repositories to return. Maximum page size is 1,000.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListRepositoriesRequest.new

# Call the list_repositories method.
result = client.list_repositories request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Repository.
  p item
end

#list_tags

def list_tags(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
def list_tags(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>

Lists tags.

Overloads 
def list_tags(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
Pass arguments to list_tags via a request object, either of type ListTagsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::ListTagsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_tags(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
Pass arguments to list_tags via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.
  • filter (::String) —

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • version

    An example of using a filter:

    • version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" --> Tags that are applied to the version 1.0 in package pkg1.
  • page_size (::Integer) — The maximum number of tags to return. Maximum page size is 10,000.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListTagsRequest.new

# Call the list_tags method.
result = client.list_tags request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Tag.
  p item
end

#list_versions

def list_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
def list_versions(parent: nil, page_size: nil, page_token: nil, view: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>

Lists versions.

Overloads 
def list_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
Pass arguments to list_versions via a request object, either of type ListVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::ListVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_versions(parent: nil, page_size: nil, page_token: nil, view: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
Pass arguments to list_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — The name of the parent resource whose versions will be listed.
  • page_size (::Integer) — The maximum number of versions to return. Maximum page size is 1,000.
  • page_token (::String) — The next_page_token value returned from a previous list request, if any.
  • view (::Google::Cloud::ArtifactRegistry::V1::VersionView) — The view that should be returned in the response.
  • order_by (::String) — Optional. The field to order the results by.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::ListVersionsRequest.new

# Call the list_versions method.
result = client.list_versions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Version.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#operations_client

def operations_client() -> ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Operations

Get the associated client for long-running operations.

Returns

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Updates the IAM policy for a given resource.

Overloads 
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

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

Overloads 
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_project_settings

def update_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
def update_project_settings(project_settings: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings

Updates the Settings for the Project.

Overloads 
def update_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
Pass arguments to update_project_settings via a request object, either of type UpdateProjectSettingsRequest or an equivalent Hash.
Parameters 
def update_project_settings(project_settings: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
Pass arguments to update_project_settings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::UpdateProjectSettingsRequest.new

# Call the update_project_settings method.
result = client.update_project_settings request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::ProjectSettings.
p result

#update_repository

def update_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
def update_repository(repository: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository

Updates a repository.

Overloads 
def update_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
Pass arguments to update_repository via a request object, either of type UpdateRepositoryRequest or an equivalent Hash.
Parameters 
def update_repository(repository: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
Pass arguments to update_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::UpdateRepositoryRequest.new

# Call the update_repository method.
result = client.update_repository request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Repository.
p result

#update_tag

def update_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
def update_tag(tag: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag

Updates a tag.

Overloads 
def update_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Pass arguments to update_tag via a request object, either of type UpdateTagRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ArtifactRegistry::V1::UpdateTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_tag(tag: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Pass arguments to update_tag via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::UpdateTagRequest.new

# Call the update_tag method.
result = client.update_tag request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::Tag.
p result

#update_vpcsc_config

def update_vpcsc_config(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig
def update_vpcsc_config(vpcsc_config: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig

Updates the VPCSC Config for the Project.

Overloads 
def update_vpcsc_config(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig
Pass arguments to update_vpcsc_config via a request object, either of type UpdateVPCSCConfigRequest or an equivalent Hash.
Parameters 
def update_vpcsc_config(vpcsc_config: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::VPCSCConfig
Pass arguments to update_vpcsc_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/artifact_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ArtifactRegistry::V1::UpdateVPCSCConfigRequest.new

# Call the update_vpcsc_config method.
result = client.update_vpcsc_config request

# The returned object is of type Google::Cloud::ArtifactRegistry::V1::VPCSCConfig.
p result