Artifact Registry v1 API - Class ArtifactRegistry.ArtifactRegistryClient (2.5.0)

public class ArtifactRegistry.ArtifactRegistryClient : ClientBase<ArtifactRegistry.ArtifactRegistryClient>

Reference documentation and code samples for the Artifact Registry v1 API class ArtifactRegistry.ArtifactRegistryClient.

Client for ArtifactRegistry

Inheritance

object > ClientBase > ClientBaseArtifactRegistryArtifactRegistryClient > ArtifactRegistry.ArtifactRegistryClient

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

ArtifactRegistryClient()

protected ArtifactRegistryClient()

Protected parameterless constructor to allow creation of test doubles.

ArtifactRegistryClient(CallInvoker)

public ArtifactRegistryClient(CallInvoker callInvoker)

Creates a new client for ArtifactRegistry that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ArtifactRegistryClient(ChannelBase)

public ArtifactRegistryClient(ChannelBase channel)

Creates a new client for ArtifactRegistry

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ArtifactRegistryClient(ClientBaseConfiguration)

protected ArtifactRegistryClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchDeleteVersions(BatchDeleteVersionsRequest, CallOptions)

public virtual Operation BatchDeleteVersions(BatchDeleteVersionsRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchDeleteVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchDeleteVersions(BatchDeleteVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation BatchDeleteVersions(BatchDeleteVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestBatchDeleteVersionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchDeleteVersionsAsync(BatchDeleteVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchDeleteVersionsAsync(BatchDeleteVersionsRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchDeleteVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

BatchDeleteVersionsAsync(BatchDeleteVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> BatchDeleteVersionsAsync(BatchDeleteVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestBatchDeleteVersionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateRepository(CreateRepositoryRequest, CallOptions)

public virtual Operation CreateRepository(CreateRepositoryRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateRepositoryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateRepository(CreateRepositoryRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateRepository(CreateRepositoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCreateRepositoryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateRepositoryAsync(CreateRepositoryRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateRepositoryAsync(CreateRepositoryRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateRepositoryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateRepositoryAsync(CreateRepositoryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateRepositoryAsync(CreateRepositoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCreateRepositoryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateTag(CreateTagRequest, CallOptions)

public virtual Tag CreateTag(CreateTagRequest request, CallOptions options)

Creates a tag.

Parameters
NameDescription
requestCreateTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Tag

The response received from the server.

CreateTag(CreateTagRequest, Metadata, DateTime?, CancellationToken)

public virtual Tag CreateTag(CreateTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a tag.

Parameters
NameDescription
requestCreateTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Tag

The response received from the server.

CreateTagAsync(CreateTagRequest, CallOptions)

public virtual AsyncUnaryCall<Tag> CreateTagAsync(CreateTagRequest request, CallOptions options)

Creates a tag.

Parameters
NameDescription
requestCreateTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTag

The call object.

CreateTagAsync(CreateTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Tag> CreateTagAsync(CreateTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a tag.

Parameters
NameDescription
requestCreateTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTag

The call object.

DeletePackage(DeletePackageRequest, CallOptions)

public virtual Operation DeletePackage(DeletePackageRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeletePackageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeletePackage(DeletePackageRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeletePackage(DeletePackageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeletePackageRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeletePackageAsync(DeletePackageRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeletePackageAsync(DeletePackageRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeletePackageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeletePackageAsync(DeletePackageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeletePackageAsync(DeletePackageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeletePackageRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteRepository(DeleteRepositoryRequest, CallOptions)

public virtual Operation DeleteRepository(DeleteRepositoryRequest request, CallOptions options)

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

Parameters
NameDescription
requestDeleteRepositoryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteRepository(DeleteRepositoryRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteRepository(DeleteRepositoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

Parameters
NameDescription
requestDeleteRepositoryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteRepositoryAsync(DeleteRepositoryRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRepositoryAsync(DeleteRepositoryRequest request, CallOptions options)

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

Parameters
NameDescription
requestDeleteRepositoryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteRepositoryAsync(DeleteRepositoryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRepositoryAsync(DeleteRepositoryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

Parameters
NameDescription
requestDeleteRepositoryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteTag(DeleteTagRequest, CallOptions)

public virtual Empty DeleteTag(DeleteTagRequest request, CallOptions options)

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTag(DeleteTagRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteTag(DeleteTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTagAsync(DeleteTagRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteTagAsync(DeleteTagRequest request, CallOptions options)

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteTagAsync(DeleteTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteTagAsync(DeleteTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteVersion(DeleteVersionRequest, CallOptions)

public virtual Operation DeleteVersion(DeleteVersionRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteVersion(DeleteVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteVersion(DeleteVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteVersionAsync(DeleteVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteVersionAsync(DeleteVersionRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteVersionAsync(DeleteVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteVersionAsync(DeleteVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetDockerImage(GetDockerImageRequest, CallOptions)

public virtual DockerImage GetDockerImage(GetDockerImageRequest request, CallOptions options)

Gets a docker image.

Parameters
NameDescription
requestGetDockerImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
DockerImage

The response received from the server.

GetDockerImage(GetDockerImageRequest, Metadata, DateTime?, CancellationToken)

public virtual DockerImage GetDockerImage(GetDockerImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a docker image.

Parameters
NameDescription
requestGetDockerImageRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
DockerImage

The response received from the server.

GetDockerImageAsync(GetDockerImageRequest, CallOptions)

public virtual AsyncUnaryCall<DockerImage> GetDockerImageAsync(GetDockerImageRequest request, CallOptions options)

Gets a docker image.

Parameters
NameDescription
requestGetDockerImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallDockerImage

The call object.

GetDockerImageAsync(GetDockerImageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DockerImage> GetDockerImageAsync(GetDockerImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a docker image.

Parameters
NameDescription
requestGetDockerImageRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallDockerImage

The call object.

GetFile(GetFileRequest, CallOptions)

public virtual File GetFile(GetFileRequest request, CallOptions options)

Gets a file.

Parameters
NameDescription
requestGetFileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
File

The response received from the server.

GetFile(GetFileRequest, Metadata, DateTime?, CancellationToken)

public virtual File GetFile(GetFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a file.

Parameters
NameDescription
requestGetFileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
File

The response received from the server.

GetFileAsync(GetFileRequest, CallOptions)

public virtual AsyncUnaryCall<File> GetFileAsync(GetFileRequest request, CallOptions options)

Gets a file.

Parameters
NameDescription
requestGetFileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallFile

The call object.

GetFileAsync(GetFileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<File> GetFileAsync(GetFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a file.

Parameters
NameDescription
requestGetFileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallFile

The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for a given resource.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM policy for a given resource.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for a given resource.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM policy for a given resource.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallPolicy

The call object.

GetMavenArtifact(GetMavenArtifactRequest, CallOptions)

public virtual MavenArtifact GetMavenArtifact(GetMavenArtifactRequest request, CallOptions options)

Gets a maven artifact.

Parameters
Name<