class Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client
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.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Operations]
Public Class Methods
Configure the ArtifactRegistry
Client
class.
See {::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all ArtifactRegistry clients ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 68 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "ArtifactRegistry", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 60.0 default_config end yield @configure if block_given? @configure end
Create a new ArtifactRegistry
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client.new # Create a client using a custom configuration client = ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the ArtifactRegistry
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 123 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/devtools/artifactregistry/v1/service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @artifact_registry_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 102 def configure yield @config if block_given? @config end
Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository
.
@overload create_repository
(request, options = nil)
Pass arguments to `create_repository` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::CreateRepositoryRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::CreateRepositoryRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_repository
(parent: nil, repository_id: nil, repository: nil)
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). @param parent [::String] Required. The name of the parent resource where the repository will be created. @param repository_id [::String] The repository id to use for this repository. @param repository [::Google::Cloud::ArtifactRegistry::V1::Repository, ::Hash] The repository to be created.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC 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::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 788 def create_repository request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::CreateRepositoryRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_repository.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_repository.timeout, metadata: metadata, retry_policy: @config.rpcs.create_repository.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :create_repository, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Creates a tag.
@overload create_tag
(request, options = nil)
Pass arguments to `create_tag` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::CreateTagRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_tag
(parent: nil, tag_id: nil, tag: nil)
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). @param parent [::String] The name of the parent resource where the tag will be created. @param tag_id [::String] The tag id to use for this repository. @param tag [::Google::Cloud::ArtifactRegistry::V1::Tag, ::Hash] The tag to be created.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Tag] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Tag]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2009 def create_tag request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::CreateTagRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_tag.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_tag.timeout, metadata: metadata, retry_policy: @config.rpcs.create_tag.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :create_tag, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
@overload delete_package
(request, options = nil)
Pass arguments to `delete_package` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::DeletePackageRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_package
(name: nil)
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). @param name [::String] Required. The name of the package to delete.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC 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::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1247 def delete_package request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::DeletePackageRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_package.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_package.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_package.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :delete_package, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
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.
@overload delete_repository
(request, options = nil)
Pass arguments to `delete_repository` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::DeleteRepositoryRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::DeleteRepositoryRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_repository
(name: nil)
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). @param name [::String] Required. The name of the repository to delete.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC 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::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 972 def delete_repository request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::DeleteRepositoryRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_repository.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_repository.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_repository.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :delete_repository, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a tag.
@overload delete_tag
(request, options = nil)
Pass arguments to `delete_tag` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::DeleteTagRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_tag
(name: nil)
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). @param name [::String] The name of the tag to delete.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2183 def delete_tag request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::DeleteTagRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_tag.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_tag.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_tag.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :delete_tag, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
@overload delete_version
(request, options = nil)
Pass arguments to `delete_version` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::DeleteVersionRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_version
(name: nil, force: nil)
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). @param name [::String] The name of the version to delete. @param 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.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC 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::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1531 def delete_version request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::DeleteVersionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_version.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_version.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_version.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :delete_version, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a docker image.
@overload get_docker_image
(request, options = nil)
Pass arguments to `get_docker_image` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetDockerImageRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_docker_image
(name: nil)
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). @param name [::String] Required. The name of the docker images.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::DockerImage] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::DockerImage]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 314 def get_docker_image request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetDockerImageRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_docker_image.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_docker_image.timeout, metadata: metadata, retry_policy: @config.rpcs.get_docker_image.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_docker_image, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a file.
@overload get_file
(request, options = nil)
Pass arguments to `get_file` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetFileRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_file
(name: nil)
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). @param name [::String] The name of the file to retrieve.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::File] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::File]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1729 def get_file request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetFileRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_file.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_file.timeout, metadata: metadata, retry_policy: @config.rpcs.get_file.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_file, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets the IAM policy for a given resource.
@overload get_iam_policy
(request, options = nil)
Pass arguments to `get_iam_policy` via a request object, either of type {::Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_iam_policy
(resource: nil, options: nil)
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). @param resource [::String] REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash] OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Iam::V1::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Iam::V1::Policy]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2363 def get_iam_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_iam_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource header_params["resource"] = request.resource end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_iam_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_iam_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a package.
@overload get_package
(request, options = nil)
Pass arguments to `get_package` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetPackageRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_package
(name: nil)
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). @param name [::String] Required. The name of the package to retrieve.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Package] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Package]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1154 def get_package request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetPackageRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_package.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_package.timeout, metadata: metadata, retry_policy: @config.rpcs.get_package.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_package, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Retrieves the Settings for the Project.
@overload get_project_settings
(request, options = nil)
Pass arguments to `get_project_settings` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetProjectSettingsRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::GetProjectSettingsRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_project_settings
(name: nil)
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). @param name [::String] Required. The name of the projectSettings resource.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::ProjectSettings] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::ProjectSettings]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2539 def get_project_settings request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetProjectSettingsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_project_settings.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_project_settings.timeout, metadata: metadata, retry_policy: @config.rpcs.get_project_settings.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_project_settings, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a repository.
@overload get_repository
(request, options = nil)
Pass arguments to `get_repository` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetRepositoryRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_repository
(name: nil)
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). @param name [::String] Required. The name of the repository to retrieve.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Repository] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Repository]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 691 def get_repository request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetRepositoryRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_repository.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_repository.timeout, metadata: metadata, retry_policy: @config.rpcs.get_repository.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_repository, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a tag.
@overload get_tag
(request, options = nil)
Pass arguments to `get_tag` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetTagRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_tag
(name: nil)
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). @param name [::String] The name of the tag to retrieve.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Tag] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Tag]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1920 def get_tag request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetTagRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_tag.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_tag.timeout, metadata: metadata, retry_policy: @config.rpcs.get_tag.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_tag, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets a version
@overload get_version
(request, options = nil)
Pass arguments to `get_version` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::GetVersionRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_version
(name: nil, view: nil)
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). @param name [::String] The name of the version to retrieve. @param view [::Google::Cloud::ArtifactRegistry::V1::VersionView] The view that should be returned in the response.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Version] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Version]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1435 def get_version request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::GetVersionRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_version.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_version.timeout, metadata: metadata, retry_policy: @config.rpcs.get_version.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :get_version, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
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.
@overload import_apt_artifacts
(request, options = nil)
Pass arguments to `import_apt_artifacts` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ImportAptArtifactsRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::ImportAptArtifactsRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload import_apt_artifacts
(gcs_source: nil, parent: nil)
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). @param gcs_source [::Google::Cloud::ArtifactRegistry::V1::ImportAptArtifactsGcsSource, ::Hash] Google Cloud Storage location where input content is located. @param parent [::String] The name of the parent resource where the artifacts will be imported.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC 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::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 411 def import_apt_artifacts request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ImportAptArtifactsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.import_apt_artifacts.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.import_apt_artifacts.timeout, metadata: metadata, retry_policy: @config.rpcs.import_apt_artifacts.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :import_apt_artifacts, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
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.
@overload import_yum_artifacts
(request, options = nil)
Pass arguments to `import_yum_artifacts` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload import_yum_artifacts
(gcs_source: nil, parent: nil)
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). @param gcs_source [::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsGcsSource, ::Hash] Google Cloud Storage location where input content is located. @param parent [::String] The name of the parent resource where the artifacts will be imported.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC 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::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 509 def import_yum_artifacts request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.import_yum_artifacts.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.import_yum_artifacts.timeout, metadata: metadata, retry_policy: @config.rpcs.import_yum_artifacts.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :import_yum_artifacts, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists docker images.
@overload list_docker_images
(request, options = nil)
Pass arguments to `list_docker_images` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ListDockerImagesRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::ListDockerImagesRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_docker_images
(parent: nil, page_size: nil, page_token: nil)
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). @param parent [::String] Required. The name of the parent resource whose docker images will be listed. @param page_size [::Integer] The maximum number of artifacts to return. @param page_token [::String] The next_page_token value returned from a previous list request, if any.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::DockerImage. p response end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 228 def list_docker_images request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ListDockerImagesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_docker_images.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_docker_images.timeout, metadata: metadata, retry_policy: @config.rpcs.list_docker_images.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :list_docker_images, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @artifact_registry_stub, :list_docker_images, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists files.
@overload list_files
(request, options = nil)
Pass arguments to `list_files` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ListFilesRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_files
(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil)
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). @param parent [::String] The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 @param 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`. @param page_size [::Integer] The maximum number of files to return. @param page_token [::String] The next_page_token value returned from a previous list request, if any. @param order_by [::String] The field to order the results by.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::File. p response end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1643 def list_files request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ListFilesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_files.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_files.timeout, metadata: metadata, retry_policy: @config.rpcs.list_files.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :list_files, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @artifact_registry_stub, :list_files, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists packages.
@overload list_packages
(request, options = nil)
Pass arguments to `list_packages` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_packages
(parent: nil, page_size: nil, page_token: nil)
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). @param parent [::String] Required. The name of the parent resource whose packages will be listed. @param page_size [::Integer] The maximum number of packages to return. Maximum page size is 1,000. @param page_token [::String] The next_page_token value returned from a previous list request, if any.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Package. p response end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1068 def list_packages request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_packages.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_packages.timeout, metadata: metadata, retry_policy: @config.rpcs.list_packages.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :list_packages, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @artifact_registry_stub, :list_packages, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists repositories.
@overload list_repositories
(request, options = nil)
Pass arguments to `list_repositories` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ListRepositoriesRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::ListRepositoriesRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_repositories
(parent: nil, page_size: nil, page_token: nil)
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). @param parent [::String] Required. The name of the parent resource whose repositories will be listed. @param page_size [::Integer] The maximum number of repositories to return. Maximum page size is 1,000. @param page_token [::String] The next_page_token value returned from a previous list request, if any.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Repository. p response end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 605 def list_repositories request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ListRepositoriesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_repositories.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_repositories.timeout, metadata: metadata, retry_policy: @config.rpcs.list_repositories.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :list_repositories, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @artifact_registry_stub, :list_repositories, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists versions.
@overload list_versions
(request, options = nil)
Pass arguments to `list_versions` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::ListVersionsRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_versions
(parent: nil, page_size: nil, page_token: nil, view: nil, order_by: nil)
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). @param parent [::String] The name of the parent resource whose versions will be listed. @param page_size [::Integer] The maximum number of versions to return. Maximum page size is 1,000. @param page_token [::String] The next_page_token value returned from a previous list request, if any. @param view [::Google::Cloud::ArtifactRegistry::V1::VersionView] The view that should be returned in the response. @param order_by [::String] Optional. The field to order the results by.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::ArtifactRegistry::V1::Version. p response end
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 1347 def list_versions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::ListVersionsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_versions.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_versions.timeout, metadata: metadata, retry_policy: @config.rpcs.list_versions.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :list_versions, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @artifact_registry_stub, :list_versions, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates the IAM policy for a given resource.
@overload set_iam_policy
(request, options = nil)
Pass arguments to `set_iam_policy` via a request object, either of type {::Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload set_iam_policy
(resource: nil, policy: nil)
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). @param resource [::String] REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. @param 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.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Iam::V1::Policy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Iam::V1::Policy]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2274 def set_iam_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.set_iam_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource header_params["resource"] = request.resource end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.set_iam_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :set_iam_policy, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Tests if the caller has a list of permissions on a resource.
@overload test_iam_permissions
(request, options = nil)
Pass arguments to `test_iam_permissions` via a request object, either of type {::Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload test_iam_permissions
(resource: nil, permissions: nil)
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). @param resource [::String] REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. @param 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](https://cloud.google.com/iam/docs/overview#permissions).
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Iam::V1::TestIamPermissionsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Iam::V1::TestIamPermissionsResponse]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2454 def test_iam_permissions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.test_iam_permissions.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.resource header_params["resource"] = request.resource end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout, metadata: metadata, retry_policy: @config.rpcs.test_iam_permissions.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates the Settings for the Project.
@overload update_project_settings
(request, options = nil)
Pass arguments to `update_project_settings` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::UpdateProjectSettingsRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::UpdateProjectSettingsRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_project_settings
(project_settings: nil, update_mask: nil)
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). @param project_settings [::Google::Cloud::ArtifactRegistry::V1::ProjectSettings, ::Hash] The project settings. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] Field mask to support partial updates.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::ProjectSettings] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::ProjectSettings]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2626 def update_project_settings request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::UpdateProjectSettingsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_project_settings.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.project_settings&.name header_params["project_settings.name"] = request.project_settings.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_project_settings.timeout, metadata: metadata, retry_policy: @config.rpcs.update_project_settings.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :update_project_settings, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates a repository.
@overload update_repository
(request, options = nil)
Pass arguments to `update_repository` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::UpdateRepositoryRequest} or an equivalent Hash. @param request [::Google::Cloud::ArtifactRegistry::V1::UpdateRepositoryRequest, ::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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_repository
(repository: nil, update_mask: nil)
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). @param repository [::Google::Cloud::ArtifactRegistry::V1::Repository, ::Hash] The repository that replaces the resource on the server. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Repository] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Repository]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 878 def update_repository request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::UpdateRepositoryRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_repository.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.repository&.name header_params["repository.name"] = request.repository.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_repository.timeout, metadata: metadata, retry_policy: @config.rpcs.update_repository.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :update_repository, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates a tag.
@overload update_tag
(request, options = nil)
Pass arguments to `update_tag` via a request object, either of type {::Google::Cloud::ArtifactRegistry::V1::UpdateTagRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_tag
(tag: nil, update_mask: nil)
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). @param tag [::Google::Cloud::ArtifactRegistry::V1::Tag, ::Hash] The tag that replaces the resource on the server. @param update_mask [::Google::Protobuf::FieldMask, ::Hash] The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::ArtifactRegistry::V1::Tag] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::ArtifactRegistry::V1::Tag]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/artifact_registry/v1/artifact_registry/client.rb, line 2098 def update_tag request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::ArtifactRegistry::V1::UpdateTagRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_tag.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::ArtifactRegistry::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.tag&.name header_params["tag.name"] = request.tag.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_tag.timeout, metadata: metadata, retry_policy: @config.rpcs.update_tag.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @artifact_registry_stub.call_rpc :update_tag, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end