Reference documentation and code samples for the Artifact Registry V1 API 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.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the ArtifactRegistry Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all ArtifactRegistry clients ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the ArtifactRegistry Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_repository
def create_repository(request, options = nil) -> ::Gapic::Operation
def create_repository(parent: nil, repository_id: nil, repository: nil) -> ::Gapic::Operation
Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
def create_repository(request, options = nil) -> ::Gapic::Operation
create_repository
via a request object, either of type
CreateRepositoryRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_repository(parent: nil, repository_id: nil, repository: nil) -> ::Gapic::Operation
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).
- parent (::String) — Required. The name of the parent resource where the repository will be created.
- repository_id (::String) — The repository id to use for this repository.
- repository (::Google::Cloud::ArtifactRegistry::V1::Repository, ::Hash) — The repository to be created.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#create_tag
def create_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
def create_tag(parent: nil, tag_id: nil, tag: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Creates a tag.
def create_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
create_tag
via a request object, either of type
CreateTagRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::CreateTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_tag(parent: nil, tag_id: nil, tag: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
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).
- parent (::String) — The name of the parent resource where the tag will be created.
- tag_id (::String) — The tag id to use for this repository.
- tag (::Google::Cloud::ArtifactRegistry::V1::Tag, ::Hash) — The tag to be created.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Tag)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_package
def delete_package(request, options = nil) -> ::Gapic::Operation
def delete_package(name: nil) -> ::Gapic::Operation
Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
def delete_package(request, options = nil) -> ::Gapic::Operation
delete_package
via a request object, either of type
DeletePackageRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::DeletePackageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_package(name: nil) -> ::Gapic::Operation
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).
- name (::String) — Required. The name of the package to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_repository
def delete_repository(request, options = nil) -> ::Gapic::Operation
def delete_repository(name: nil) -> ::Gapic::Operation
Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.
def delete_repository(request, options = nil) -> ::Gapic::Operation
delete_repository
via a request object, either of type
DeleteRepositoryRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_repository(name: nil) -> ::Gapic::Operation
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).
- name (::String) — Required. The name of the repository to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_tag
def delete_tag(request, options = nil) -> ::Google::Protobuf::Empty
def delete_tag(name: nil) -> ::Google::Protobuf::Empty
Deletes a tag.
def delete_tag(request, options = nil) -> ::Google::Protobuf::Empty
delete_tag
via a request object, either of type
DeleteTagRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::DeleteTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_tag(name: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — The name of the tag to delete.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#delete_version
def delete_version(request, options = nil) -> ::Gapic::Operation
def delete_version(name: nil, force: nil) -> ::Gapic::Operation
Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
def delete_version(request, options = nil) -> ::Gapic::Operation
delete_version
via a request object, either of type
DeleteVersionRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::DeleteVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_version(name: nil, force: nil) -> ::Gapic::Operation
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).
- name (::String) — The name of the version to delete.
- force (::Boolean) — By default, a version that is tagged may not be deleted. If force=true, the version and any tags pointing to the version are deleted.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_docker_image
def get_docker_image(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
def get_docker_image(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
Gets a docker image.
def get_docker_image(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
get_docker_image
via a request object, either of type
GetDockerImageRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::GetDockerImageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_docker_image(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::DockerImage
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).
- name (::String) — Required. The name of the docker images.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::DockerImage)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_file
def get_file(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
def get_file(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
Gets a file.
def get_file(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
get_file
via a request object, either of type
GetFileRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::GetFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_file(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::File
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).
- name (::String) — The name of the file to retrieve.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::File)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Gets the IAM policy for a given resource.
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via a request object, either of type
Iam::V1::GetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
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).
- resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
-
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_package
def get_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
def get_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
Gets a package.
def get_package(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
get_package
via a request object, either of type
GetPackageRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::GetPackageRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_package(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Package
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).
- name (::String) — Required. The name of the package to retrieve.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Package)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_project_settings
def get_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
def get_project_settings(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
Retrieves the Settings for the Project.
def get_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
get_project_settings
via a request object, either of type
GetProjectSettingsRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_project_settings(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
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).
- name (::String) — Required. The name of the projectSettings resource.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::ProjectSettings)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_repository
def get_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
def get_repository(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
Gets a repository.
def get_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
get_repository
via a request object, either of type
GetRepositoryRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::GetRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_repository(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
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).
- name (::String) — Required. The name of the repository to retrieve.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Repository)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_tag
def get_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
def get_tag(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Gets a tag.
def get_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
get_tag
via a request object, either of type
GetTagRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::GetTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_tag(name: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
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).
- name (::String) — The name of the tag to retrieve.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Tag)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#get_version
def get_version(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
def get_version(name: nil, view: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
Gets a version
def get_version(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
get_version
via a request object, either of type
GetVersionRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::GetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_version(name: nil, view: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Version
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).
- name (::String) — The name of the version to retrieve.
- view (::Google::Cloud::ArtifactRegistry::V1::VersionView) — The view that should be returned in the response.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Version)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#import_apt_artifacts
def import_apt_artifacts(request, options = nil) -> ::Gapic::Operation
def import_apt_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation
Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
def import_apt_artifacts(request, options = nil) -> ::Gapic::Operation
import_apt_artifacts
via a request object, either of type
ImportAptArtifactsRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def import_apt_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation
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).
- gcs_source (::Google::Cloud::ArtifactRegistry::V1::ImportAptArtifactsGcsSource, ::Hash) — Google Cloud Storage location where input content is located.
- parent (::String) — The name of the parent resource where the artifacts will be imported.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#import_yum_artifacts
def import_yum_artifacts(request, options = nil) -> ::Gapic::Operation
def import_yum_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation
Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
def import_yum_artifacts(request, options = nil) -> ::Gapic::Operation
import_yum_artifacts
via a request object, either of type
ImportYumArtifactsRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def import_yum_artifacts(gcs_source: nil, parent: nil) -> ::Gapic::Operation
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).
- gcs_source (::Google::Cloud::ArtifactRegistry::V1::ImportYumArtifactsGcsSource, ::Hash) — Google Cloud Storage location where input content is located.
- parent (::String) — The name of the parent resource where the artifacts will be imported.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#initialize
def initialize() { |config| ... } -> Client
Create a new ArtifactRegistry client object.
- (config) — Configure the ArtifactRegistry client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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
#list_docker_images
def list_docker_images(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
def list_docker_images(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
Lists docker images.
def list_docker_images(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
list_docker_images
via a request object, either of type
ListDockerImagesRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_docker_images(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>
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).
- parent (::String) — Required. The name of the parent resource whose docker images will be listed.
- page_size (::Integer) — The maximum number of artifacts to return.
- page_token (::String) — The next_page_token value returned from a previous list request, if any.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::DockerImage>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_files
def list_files(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
def list_files(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
Lists files.
def list_files(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
list_files
via a request object, either of type
ListFilesRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::ListFilesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_files(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>
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).
- parent (::String) — The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
-
filter (::String) —
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
name
owner
An example of using a filter:
name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"
--> Files with an ID starting with "a/b/".owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"
--> Files owned by the version1.0
in packagepkg1
.
- page_size (::Integer) — The maximum number of files to return.
- page_token (::String) — The next_page_token value returned from a previous list request, if any.
- order_by (::String) — The field to order the results by.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::File>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_packages
def list_packages(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
def list_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
Lists packages.
def list_packages(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
list_packages
via a request object, either of type
ListPackagesRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_packages(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>
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).
- parent (::String) — Required. The name of the parent resource whose packages will be listed.
- page_size (::Integer) — The maximum number of packages to return. Maximum page size is 1,000.
- page_token (::String) — The next_page_token value returned from a previous list request, if any.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Package>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_repositories
def list_repositories(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
def list_repositories(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
Lists repositories.
def list_repositories(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
list_repositories
via a request object, either of type
ListRepositoriesRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_repositories(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>
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).
- parent (::String) — Required. The name of the parent resource whose repositories will be listed.
- page_size (::Integer) — The maximum number of repositories to return. Maximum page size is 1,000.
- page_token (::String) — The next_page_token value returned from a previous list request, if any.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Repository>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#list_tags
def list_tags(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
def list_tags(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
Lists tags.
def list_tags(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
list_tags
via a request object, either of type
ListTagsRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::ListTagsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_tags(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>
list_tags
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — The name of the parent resource whose tags will be listed.
-
filter (::String) —
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
version
An example of using a filter:
version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"
--> Tags that are applied to the version1.0
in packagepkg1
.
- page_size (::Integer) — The maximum number of tags to return. Maximum page size is 10,000.
- page_token (::String) — The next_page_token value returned from a previous list request, if any.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Tag>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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::ListTagsRequest.new # Call the list_tags method. result = client.list_tags 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::Tag. p response end
#list_versions
def list_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
def list_versions(parent: nil, page_size: nil, page_token: nil, view: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
Lists versions.
def list_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
list_versions
via a request object, either of type
ListVersionsRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::ListVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_versions(parent: nil, page_size: nil, page_token: nil, view: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>
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).
- parent (::String) — The name of the parent resource whose versions will be listed.
- page_size (::Integer) — The maximum number of versions to return. Maximum page size is 1,000.
- page_token (::String) — The next_page_token value returned from a previous list request, if any.
- view (::Google::Cloud::ArtifactRegistry::V1::VersionView) — The view that should be returned in the response.
- order_by (::String) — Optional. The field to order the results by.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::ArtifactRegistry::V1::Version>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::ArtifactRegistry::V1::ArtifactRegistry::Operations
Get the associated client for long-running operations.
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Updates the IAM policy for a given resource.
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via a request object, either of type
Iam::V1::SetIamPolicyRequest or an equivalent Hash.
- request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
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).
- resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
-
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. -
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
the fields in the mask will be modified. If no mask is provided, the
following default mask is used:
paths: "bindings, etag"
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Tests if the caller has a list of permissions on a resource.
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via a request object, either of type
Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
- request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
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).
- resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
-
permissions (::Array<::String>) — The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#update_project_settings
def update_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
def update_project_settings(project_settings: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
Updates the Settings for the Project.
def update_project_settings(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
update_project_settings
via a request object, either of type
UpdateProjectSettingsRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_project_settings(project_settings: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::ProjectSettings
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).
- project_settings (::Google::Cloud::ArtifactRegistry::V1::ProjectSettings, ::Hash) — The project settings.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Field mask to support partial updates.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::ProjectSettings)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#update_repository
def update_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
def update_repository(repository: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
Updates a repository.
def update_repository(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
update_repository
via a request object, either of type
UpdateRepositoryRequest or an equivalent Hash.
- 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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_repository(repository: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Repository
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).
- repository (::Google::Cloud::ArtifactRegistry::V1::Repository, ::Hash) — The repository that replaces the resource on the server.
-
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
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Repository)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#update_tag
def update_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
def update_tag(tag: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
Updates a tag.
def update_tag(request, options = nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
update_tag
via a request object, either of type
UpdateTagRequest or an equivalent Hash.
- request (::Google::Cloud::ArtifactRegistry::V1::UpdateTagRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_tag(tag: nil, update_mask: nil) -> ::Google::Cloud::ArtifactRegistry::V1::Tag
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).
- tag (::Google::Cloud::ArtifactRegistry::V1::Tag, ::Hash) — The tag that replaces the resource on the server.
-
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
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::ArtifactRegistry::V1::Tag)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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