By default, this returns an instance of
Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the ArtifactRegistry service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
You can also specify a different transport by passing :rest or :grpc in
the transport parameter.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the given transport of the ArtifactRegistry service.
You can determine whether the method will succeed by calling
ArtifactRegistry.artifact_registry_available?.
About ArtifactRegistry
The Artifact Registry API service.
Artifact Registry is an artifact management system for storing artifacts
from different package management systems.
The resources managed by this API are:
Repositories, which group packages and their data.
Packages, which group versions and their tags.
Versions, which are specific forms of a package.
Tags, which represent alternative names for versions.
Files, which contain content and are optionally associated with a Package
or Version.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(::Object) — A client object for the specified version.
Determines whether the ArtifactRegistry service is supported by the current client.
If true, you can retrieve a client object by calling ArtifactRegistry.artifact_registry.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the ArtifactRegistry service,
or if the versioned client gem needs an update to support the ArtifactRegistry service.
Parameters
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
(boolean) — Whether the service is available.
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-artifact_registry library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.artifact_registry)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Artifact Registry API - Module Google::Cloud::ArtifactRegistry (v2.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.1 (latest)](/ruby/docs/reference/google-cloud-artifact_registry/latest/Google-Cloud-ArtifactRegistry)\n- [2.0.0](/ruby/docs/reference/google-cloud-artifact_registry/2.0.0/Google-Cloud-ArtifactRegistry)\n- [1.5.0](/ruby/docs/reference/google-cloud-artifact_registry/1.5.0/Google-Cloud-ArtifactRegistry)\n- [1.4.0](/ruby/docs/reference/google-cloud-artifact_registry/1.4.0/Google-Cloud-ArtifactRegistry)\n- [1.3.0](/ruby/docs/reference/google-cloud-artifact_registry/1.3.0/Google-Cloud-ArtifactRegistry)\n- [1.2.0](/ruby/docs/reference/google-cloud-artifact_registry/1.2.0/Google-Cloud-ArtifactRegistry)\n- [1.1.0](/ruby/docs/reference/google-cloud-artifact_registry/1.1.0/Google-Cloud-ArtifactRegistry)\n- [1.0.1](/ruby/docs/reference/google-cloud-artifact_registry/1.0.1/Google-Cloud-ArtifactRegistry) \nReference documentation and code samples for the Artifact Registry API module Google::Cloud::ArtifactRegistry.\n\nMethods\n-------\n\n### .artifact_registry\n\n def self.artifact_registry(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for ArtifactRegistry.\n\nBy default, this returns an instance of\n[Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-artifact_registry-v1/latest/Google-Cloud-ArtifactRegistry-V1-ArtifactRegistry-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the ArtifactRegistry service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the ArtifactRegistry service.\nYou can determine whether the method will succeed by calling\n[ArtifactRegistry.artifact_registry_available?](/ruby/docs/reference/google-cloud-artifact_registry/latest/Google-Cloud-ArtifactRegistry#Google__Cloud__ArtifactRegistry_artifact_registry_available__class_ \"Google::Cloud::ArtifactRegistry.artifact_registry_available? (method)\").\n\n#### About ArtifactRegistry\n\nThe Artifact Registry API service.\n\nArtifact Registry is an artifact management system for storing artifacts\nfrom different package management systems.\n\nThe resources managed by this API are:\n\n- Repositories, which group packages and their data.\n- Packages, which group versions and their tags.\n- Versions, which are specific forms of a package.\n- Tags, which represent alternative names for versions.\n- Files, which contain content and are optionally associated with a Package or Version. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .artifact_registry_available?\n\n def self.artifact_registry_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the ArtifactRegistry service is supported by the current client.\nIf true, you can retrieve a client object by calling [ArtifactRegistry.artifact_registry](/ruby/docs/reference/google-cloud-artifact_registry/latest/Google-Cloud-ArtifactRegistry#Google__Cloud__ArtifactRegistry_artifact_registry_class_ \"Google::Cloud::ArtifactRegistry.artifact_registry (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the ArtifactRegistry service,\nor if the versioned client gem needs an update to support the ArtifactRegistry service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-artifact_registry library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.artifact_registry) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.1\""]]