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. v1beta2
Package
@google-cloud/artifact-registry!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of ArtifactRegistryClient.
Parameter
Type | Name | Description |
---|
ClientOptions | opts |
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
artifactRegistryStub
artifactRegistryStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
---|
Promise<{
[name: string]: Function;
}> | |
auth
Property Value
Type | Description |
---|
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
---|
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
---|
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
---|
gax.OperationsClient | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
---|
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
---|
(code: string, message: string, warnType?: string) => void | |
Methods
checkCreateRepositoryProgress(name)
checkCreateRepositoryProgress(name: string): Promise<LROperation<protos.google.devtools.artifactregistry.v1beta2.Repository, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>>;
Check the status of the long running operation returned by createRepository()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.devtools.artifactregistry.v1beta2.Repository, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDeletePackageProgress(name)
checkDeletePackageProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>>;
Check the status of the long running operation returned by deletePackage()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDeleteRepositoryProgress(name)
checkDeleteRepositoryProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>>;
Check the status of the long running operation returned by deleteRepository()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkDeleteVersionProgress(name)
checkDeleteVersionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>>;
Check the status of the long running operation returned by deleteVersion()
.
Parameter
Type | Name | Description |
---|
string | name |
The operation name that will be passed.
|
Returns
Type | Description |
---|
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1beta2.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
---|
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
createRepository(request, options)
createRepository(request?: protos.google.devtools.artifactregistry.v1beta2.ICreateRepositoryRequest, options?: CallOptions): Promise<[
LROperation<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.ICreateRepositoryRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
createRepository(request, options, callback)
createRepository(request: protos.google.devtools.artifactregistry.v1beta2.ICreateRepositoryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.ICreateRepositoryRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
createRepository(request, callback)
createRepository(request: protos.google.devtools.artifactregistry.v1beta2.ICreateRepositoryRequest, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.ICreateRepositoryRequest | request |
|
Callback<LROperation<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
createTag(request, options)
createTag(request?: protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag,
(protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag,
(protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | undefined),
{} | undefined
]> | |
createTag(request, options, callback)
createTag(request: protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
createTag(request, callback)
createTag(request: protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.ICreateTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
deletePackage(request, options)
deletePackage(request?: protos.google.devtools.artifactregistry.v1beta2.IDeletePackageRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeletePackageRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deletePackage(request, options, callback)
deletePackage(request: protos.google.devtools.artifactregistry.v1beta2.IDeletePackageRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeletePackageRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
deletePackage(request, callback)
deletePackage(request: protos.google.devtools.artifactregistry.v1beta2.IDeletePackageRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeletePackageRequest | request |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteRepository(request, options)
deleteRepository(request?: protos.google.devtools.artifactregistry.v1beta2.IDeleteRepositoryRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteRepositoryRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteRepository(request, options, callback)
deleteRepository(request: protos.google.devtools.artifactregistry.v1beta2.IDeleteRepositoryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteRepositoryRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteRepository(request, callback)
deleteRepository(request: protos.google.devtools.artifactregistry.v1beta2.IDeleteRepositoryRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteRepositoryRequest | request |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteTag(request, options)
deleteTag(request?: protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | undefined),
{} | undefined
]> | |
deleteTag(request, options, callback)
deleteTag(request: protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | request |
|
CallOptions | options |
|
Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteTag(request, callback)
deleteTag(request: protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | request |
|
Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IDeleteTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteVersion(request, options)
deleteVersion(request?: protos.google.devtools.artifactregistry.v1beta2.IDeleteVersionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteVersionRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | |
deleteVersion(request, options, callback)
deleteVersion(request: protos.google.devtools.artifactregistry.v1beta2.IDeleteVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteVersionRequest | request |
|
CallOptions | options |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
deleteVersion(request, callback)
deleteVersion(request: protos.google.devtools.artifactregistry.v1beta2.IDeleteVersionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IDeleteVersionRequest | request |
|
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1beta2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> | callback |
|
Returns
filePath(project, location, repo, file)
filePath(project: string, location: string, repo: string, file: string): string;
Return a fully-qualified file resource name string.
Parameters
Type | Name | Description |
---|
string | project |
|
string | location |
|
string | repo |
|
string | file |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
getFile(request, options)
getFile(request?: protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IFile,
(protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IFile,
(protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | undefined),
{} | undefined
]> | |
getFile(request, options, callback)
getFile(request: protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IFile, protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IFile, protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getFile(request, callback)
getFile(request: protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IFile, protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IFile, protos.google.devtools.artifactregistry.v1beta2.IGetFileRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getIamPolicy(request, options)
getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.IGetIamPolicyRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.IGetIamPolicyRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.IGetIamPolicyRequest | undefined,
{} | undefined
]> | |
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.IGetIamPolicyRequest | request |
|
CallOptions | options |
|
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.IGetIamPolicyRequest | request |
|
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getPackage(request, options)
getPackage(request?: protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IPackage,
(protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IPackage,
(protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | undefined),
{} | undefined
]> | |
getPackage(request, options, callback)
getPackage(request: protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IPackage, protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IPackage, protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getPackage(request, callback)
getPackage(request: protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IPackage, protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IPackage, protos.google.devtools.artifactregistry.v1beta2.IGetPackageRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
---|
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Type | Name | Description |
---|
Callback<string, undefined, undefined> | callback |
|
Returns
getRepository(request, options)
getRepository(request?: protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IRepository,
(protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IRepository,
(protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | undefined),
{} | undefined
]> | |
getRepository(request, options, callback)
getRepository(request: protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getRepository(request, callback)
getRepository(request: protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IGetRepositoryRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getTag(request, options)
getTag(request?: protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag,
(protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag,
(protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | undefined),
{} | undefined
]> | |
getTag(request, options, callback)
getTag(request: protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getTag(request, callback)
getTag(request: protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IGetTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getVersion(request, options)
getVersion(request?: protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IVersion,
(protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IVersion,
(protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | undefined),
{} | undefined
]> | |
getVersion(request, options, callback)
getVersion(request: protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IVersion, protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IVersion, protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
getVersion(request, callback)
getVersion(request: protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IVersion, protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IVersion, protos.google.devtools.artifactregistry.v1beta2.IGetVersionRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns
Type | Description |
---|
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listFiles(request, options)
listFiles(request?: protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IFile[],
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListFilesResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IFile[],
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListFilesResponse
]> | |
listFiles(request, options, callback)
listFiles(request: protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, protos.google.devtools.artifactregistry.v1beta2.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IFile>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, protos.google.devtools.artifactregistry.v1beta2.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IFile> | callback |
|
Returns
listFiles(request, callback)
listFiles(request: protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, protos.google.devtools.artifactregistry.v1beta2.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IFile>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | request |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, protos.google.devtools.artifactregistry.v1beta2.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IFile> | callback |
|
Returns
listFilesAsync(request, options)
listFilesAsync(request?: protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IFile>;
Equivalent to listFiles
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IFile> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [File]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listFilesStream(request, options)
listFilesStream(request?: protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListFilesRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [File] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFilesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listPackages(request, options)
listPackages(request?: protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IPackage[],
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListPackagesResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IPackage[],
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListPackagesResponse
]> | |
listPackages(request, options, callback)
listPackages(request: protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, protos.google.devtools.artifactregistry.v1beta2.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IPackage>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, protos.google.devtools.artifactregistry.v1beta2.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IPackage> | callback |
|
Returns
listPackages(request, callback)
listPackages(request: protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, protos.google.devtools.artifactregistry.v1beta2.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IPackage>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | request |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, protos.google.devtools.artifactregistry.v1beta2.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IPackage> | callback |
|
Returns
listPackagesAsync(request, options)
listPackagesAsync(request?: protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IPackage>;
Equivalent to listPackages
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IPackage> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Package]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listPackagesStream(request, options)
listPackagesStream(request?: protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListPackagesRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Package] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPackagesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listRepositories(request, options)
listRepositories(request?: protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IRepository[],
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IRepository[],
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesResponse
]> | |
listRepositories(request, options, callback)
listRepositories(request: protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IRepository>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IRepository> | callback |
|
Returns
listRepositories(request, callback)
listRepositories(request: protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IRepository>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | request |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IRepository> | callback |
|
Returns
listRepositoriesAsync(request, options)
listRepositoriesAsync(request?: protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IRepository>;
Equivalent to listRepositories
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IRepository> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Repository]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listRepositoriesStream(request, options)
listRepositoriesStream(request?: protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListRepositoriesRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Repository] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRepositoriesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTags(request?: protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag[],
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListTagsResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag[],
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListTagsResponse
]> | |
listTags(request: protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, protos.google.devtools.artifactregistry.v1beta2.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.ITag>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, protos.google.devtools.artifactregistry.v1beta2.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.ITag> | callback |
|
Returns
listTags(request: protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, protos.google.devtools.artifactregistry.v1beta2.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.ITag>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | request |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, protos.google.devtools.artifactregistry.v1beta2.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.ITag> | callback |
|
Returns
listTagsAsync(request?: protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.ITag>;
Equivalent to listTags
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.ITag> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Tag]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTagsStream(request?: protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListTagsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Tag] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTagsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listVersions(request, options)
listVersions(request?: protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IVersion[],
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListVersionsResponse
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IVersion[],
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | null,
protos.google.devtools.artifactregistry.v1beta2.IListVersionsResponse
]> | |
listVersions(request, options, callback)
listVersions(request: protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, protos.google.devtools.artifactregistry.v1beta2.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IVersion>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | request |
|
CallOptions | options |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, protos.google.devtools.artifactregistry.v1beta2.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IVersion> | callback |
|
Returns
listVersions(request, callback)
listVersions(request: protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, protos.google.devtools.artifactregistry.v1beta2.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IVersion>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | request |
|
PaginationCallback<protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, protos.google.devtools.artifactregistry.v1beta2.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1beta2.IVersion> | callback |
|
Returns
listVersionsAsync(request, options)
listVersionsAsync(request?: protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IVersion>;
Equivalent to listVersions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
AsyncIterable<protos.google.devtools.artifactregistry.v1beta2.IVersion> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Version]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listVersionsStream(request, options)
listVersionsStream(request?: protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IListVersionsRequest | request |
The request object that will be sent.
|
CallOptions | options |
Call options. See CallOptions for more details.
|
Returns
Type | Description |
---|
Transform | {Stream} An object stream which emits an object representing [Version] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listVersionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
matchFileFromFileName(fileName)
matchFileFromFileName(fileName: string): string | number;
Parse the file from File resource.
Parameter
Type | Name | Description |
---|
string | fileName |
A fully-qualified path representing File resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the file.
|
matchLocationFromFileName(fileName)
matchLocationFromFileName(fileName: string): string | number;
Parse the location from File resource.
Parameter
Type | Name | Description |
---|
string | fileName |
A fully-qualified path representing File resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the location.
|
matchLocationFromRepositoryName(repositoryName)
matchLocationFromRepositoryName(repositoryName: string): string | number;
Parse the location from Repository resource.
Parameter
Type | Name | Description |
---|
string | repositoryName |
A fully-qualified path representing Repository resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the location.
|
matchProjectFromFileName(fileName)
matchProjectFromFileName(fileName: string): string | number;
Parse the project from File resource.
Parameter
Type | Name | Description |
---|
string | fileName |
A fully-qualified path representing File resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the project.
|
matchProjectFromRepositoryName(repositoryName)
matchProjectFromRepositoryName(repositoryName: string): string | number;
Parse the project from Repository resource.
Parameter
Type | Name | Description |
---|
string | repositoryName |
A fully-qualified path representing Repository resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the project.
|
matchRepoFromFileName(fileName)
matchRepoFromFileName(fileName: string): string | number;
Parse the repo from File resource.
Parameter
Type | Name | Description |
---|
string | fileName |
A fully-qualified path representing File resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the repo.
|
matchRepositoryFromRepositoryName(repositoryName)
matchRepositoryFromRepositoryName(repositoryName: string): string | number;
Parse the repository from Repository resource.
Parameter
Type | Name | Description |
---|
string | repositoryName |
A fully-qualified path representing Repository resource.
|
Returns
Type | Description |
---|
string | number | {string} A string representing the repository.
|
repositoryPath(project, location, repository)
repositoryPath(project: string, location: string, repository: string): string;
Return a fully-qualified repository resource name string.
Parameters
Type | Name | Description |
---|
string | project |
|
string | location |
|
string | repository |
|
Returns
Type | Description |
---|
string | {string} Resource name string.
|
setIamPolicy(request, options)
setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.ISetIamPolicyRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.ISetIamPolicyRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.ISetIamPolicyRequest | undefined,
{} | undefined
]> | |
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.ISetIamPolicyRequest | request |
|
CallOptions | options |
|
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.ISetIamPolicyRequest | request |
|
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.ITestIamPermissionsResponse,
protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.ITestIamPermissionsRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.iam.v1.ITestIamPermissionsResponse,
protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
{} | undefined
]> | |
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.ITestIamPermissionsRequest | request |
|
CallOptions | options |
|
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.iam.v1.ITestIamPermissionsRequest | request |
|
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateRepository(request, options)
updateRepository(request?: protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.IRepository,
(protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.IRepository,
(protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | undefined),
{} | undefined
]> | |
updateRepository(request, options, callback)
updateRepository(request: protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateRepository(request, callback)
updateRepository(request: protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.IRepository, protos.google.devtools.artifactregistry.v1beta2.IUpdateRepositoryRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateTag(request, options)
updateTag(request?: protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag,
(protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | undefined),
{} | undefined
]>;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | request |
|
CallOptions | options |
|
Returns
Type | Description |
---|
Promise<[
protos.google.devtools.artifactregistry.v1beta2.ITag,
(protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | undefined),
{} | undefined
]> | |
updateTag(request, options, callback)
updateTag(request: protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | request |
|
CallOptions | options |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns
updateTag(request, callback)
updateTag(request: protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest, callback: Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type | Name | Description |
---|
protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | request |
|
Callback<protos.google.devtools.artifactregistry.v1beta2.ITag, protos.google.devtools.artifactregistry.v1beta2.IUpdateTagRequest | null | undefined, {} | null | undefined> | callback |
|
Returns