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. v1
Package
@google-cloud/artifact-registryConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);Construct an instance of ArtifactRegistryClient.
| Parameters | |
|---|---|
| Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;The DNS address for this API service - same as servicePath.
artifactRegistryStub
artifactRegistryStub?: Promise<{
[name: string]: Function;
}>;auth
auth: gax.GoogleAuth;descriptors
descriptors: Descriptors;innerApiCalls
innerApiCalls: {
[name: string]: Function;
};locationsClient
locationsClient: LocationsClient;operationsClient
operationsClient: gax.OperationsClient;pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};port
static get port(): number;The port for this API service.
scopes
static get scopes(): string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;The DNS address for this API service.
universeDomain
get universeDomain(): string;warn
warn: (code: string, message: string, warnType?: string) => void;Methods
aptArtifactPath(project, location, repository, aptArtifact)
aptArtifactPath(project: string, location: string, repository: string, aptArtifact: string): string;Return a fully-qualified aptArtifact resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
aptArtifact |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
attachmentPath(project, location, repository, attachment)
attachmentPath(project: string, location: string, repository: string, attachment: string): string;Return a fully-qualified attachment resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
attachment |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
batchDeleteVersions(request, options)
batchDeleteVersions(request?: protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes multiple versions across a repository. The returned operation will complete once the versions have been deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
IBatchDeleteVersionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the repository holding all requested versions.
*/
// const parent = 'abc123'
/**
* Required. The names of the versions to delete.
* The maximum number of versions deleted per batch is determined by the
* service and is dependent on the available resources in the region.
*/
// const names = ['abc','def']
/**
* If true, the request is performed without deleting data, following AIP-163.
*/
// const validateOnly = true
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callBatchDeleteVersions() {
// Construct request
const request = {
names,
};
// Run request
const [operation] = await artifactregistryClient.batchDeleteVersions(request);
const [response] = await operation.promise();
console.log(response);
}
callBatchDeleteVersions();
batchDeleteVersions(request, options, callback)
batchDeleteVersions(request: protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IBatchDeleteVersionsRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
batchDeleteVersions(request, callback)
batchDeleteVersions(request: protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IBatchDeleteVersionsRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IBatchDeleteVersionsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
cancelOperation(request, optionsOrCallback, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
optionsOrCallback |
CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
|
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<protos.google.protobuf.Empty> |
|
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkBatchDeleteVersionsProgress(name)
checkBatchDeleteVersionsProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.BatchDeleteVersionsMetadata>>;Check the status of the long running operation returned by batchDeleteVersions().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.BatchDeleteVersionsMetadata>> |
{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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the repository holding all requested versions.
*/
// const parent = 'abc123'
/**
* Required. The names of the versions to delete.
* The maximum number of versions deleted per batch is determined by the
* service and is dependent on the available resources in the region.
*/
// const names = ['abc','def']
/**
* If true, the request is performed without deleting data, following AIP-163.
*/
// const validateOnly = true
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callBatchDeleteVersions() {
// Construct request
const request = {
names,
};
// Run request
const [operation] = await artifactregistryClient.batchDeleteVersions(request);
const [response] = await operation.promise();
console.log(response);
}
callBatchDeleteVersions();
checkCreateAttachmentProgress(name)
checkCreateAttachmentProgress(name: string): Promise<LROperation<protos.google.devtools.artifactregistry.v1.Attachment, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by createAttachment().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.devtools.artifactregistry.v1.Attachment, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource where the attachment will be
* created.
*/
// const parent = 'abc123'
/**
* Required. The attachment id to use for this attachment.
*/
// const attachmentId = 'abc123'
/**
* Required. The attachment to be created.
*/
// const attachment = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callCreateAttachment() {
// Construct request
const request = {
parent,
attachmentId,
attachment,
};
// Run request
const [operation] = await artifactregistryClient.createAttachment(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateAttachment();
checkCreateRepositoryProgress(name)
checkCreateRepositoryProgress(name: string): Promise<LROperation<protos.google.devtools.artifactregistry.v1.Repository, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by createRepository().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.devtools.artifactregistry.v1.Repository, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource where the repository will be
* created.
*/
// const parent = 'abc123'
/**
* Required. The repository id to use for this repository.
*/
// const repositoryId = 'abc123'
/**
* Required. The repository to be created.
*/
// const repository = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callCreateRepository() {
// Construct request
const request = {
parent,
repositoryId,
repository,
};
// Run request
const [operation] = await artifactregistryClient.createRepository(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateRepository();
checkDeleteAttachmentProgress(name)
checkDeleteAttachmentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteAttachment().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the attachment to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteAttachment() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deleteAttachment(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteAttachment();
checkDeleteFileProgress(name)
checkDeleteFileProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteFile().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the file to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteFile() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deleteFile(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteFile();
checkDeletePackageProgress(name)
checkDeletePackageProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by deletePackage().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the package to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeletePackage() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deletePackage(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePackage();
checkDeleteRepositoryProgress(name)
checkDeleteRepositoryProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteRepository().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the repository to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteRepository() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deleteRepository(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteRepository();
checkDeleteVersionProgress(name)
checkDeleteVersionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.OperationMetadata>>;Check the status of the long running operation returned by deleteVersion().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.devtools.artifactregistry.v1.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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the version to delete.
*/
// const name = 'abc123'
/**
* 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.
*/
// const force = true
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteVersion() {
// Construct request
const request = {
};
// Run request
const [operation] = await artifactregistryClient.deleteVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteVersion();
checkExportArtifactProgress(name)
checkExportArtifactProgress(name: string): Promise<LROperation<protos.google.devtools.artifactregistry.v1.ExportArtifactResponse, protos.google.devtools.artifactregistry.v1.ExportArtifactMetadata>>;Check the status of the long running operation returned by exportArtifact().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.devtools.artifactregistry.v1.ExportArtifactResponse, protos.google.devtools.artifactregistry.v1.ExportArtifactMetadata>> |
{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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The artifact version to export.
* Format:
* projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}
*/
// const sourceVersion = 'abc123'
/**
* The artifact tag to export.
* Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}
*/
// const sourceTag = 'abc123'
/**
* The Cloud Storage path to export the artifact to. Should start with the
* bucket name, and optionally have a directory path. Examples:
* `dst_bucket`, `dst_bucket/sub_dir`.
* Existing objects with the same path will be overwritten.
*/
// const gcsPath = 'abc123'
/**
* Required. The repository of the artifact to export.
* Format: projects/{project}/locations/{location}/repositories/{repository}
*/
// const repository = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callExportArtifact() {
// Construct request
const request = {
repository,
};
// Run request
const [operation] = await artifactregistryClient.exportArtifact(request);
const [response] = await operation.promise();
console.log(response);
}
callExportArtifact();
checkImportAptArtifactsProgress(name)
checkImportAptArtifactsProgress(name: string): Promise<LROperation<protos.google.devtools.artifactregistry.v1.ImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.ImportAptArtifactsMetadata>>;Check the status of the long running operation returned by importAptArtifacts().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.devtools.artifactregistry.v1.ImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.ImportAptArtifactsMetadata>> |
{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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Google Cloud Storage location where input content is located.
*/
// const gcsSource = {}
/**
* The name of the parent resource where the artifacts will be imported.
*/
// const parent = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callImportAptArtifacts() {
// Construct request
const request = {
};
// Run request
const [operation] = await artifactregistryClient.importAptArtifacts(request);
const [response] = await operation.promise();
console.log(response);
}
callImportAptArtifacts();
checkImportYumArtifactsProgress(name)
checkImportYumArtifactsProgress(name: string): Promise<LROperation<protos.google.devtools.artifactregistry.v1.ImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.ImportYumArtifactsMetadata>>;Check the status of the long running operation returned by importYumArtifacts().
| Parameter | |
|---|---|
| Name | Description |
name |
string
The operation name that will be passed. |
| Returns | |
|---|---|
| Type | Description |
Promise<LROperation<protos.google.devtools.artifactregistry.v1.ImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.ImportYumArtifactsMetadata>> |
{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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Google Cloud Storage location where input content is located.
*/
// const gcsSource = {}
/**
* The name of the parent resource where the artifacts will be imported.
*/
// const parent = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callImportYumArtifacts() {
// Construct request
const request = {
};
// Run request
const [operation] = await artifactregistryClient.importYumArtifacts(request);
const [response] = await operation.promise();
console.log(response);
}
callImportYumArtifacts();
close()
close(): Promise<void>;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. |
createAttachment(request, options)
createAttachment(request?: protos.google.devtools.artifactregistry.v1.ICreateAttachmentRequest, options?: CallOptions): Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Creates an attachment. The returned Operation will finish once the attachment has been created. Its response will be the created attachment.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateAttachmentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource where the attachment will be
* created.
*/
// const parent = 'abc123'
/**
* Required. The attachment id to use for this attachment.
*/
// const attachmentId = 'abc123'
/**
* Required. The attachment to be created.
*/
// const attachment = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callCreateAttachment() {
// Construct request
const request = {
parent,
attachmentId,
attachment,
};
// Run request
const [operation] = await artifactregistryClient.createAttachment(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateAttachment();
createAttachment(request, options, callback)
createAttachment(request: protos.google.devtools.artifactregistry.v1.ICreateAttachmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateAttachmentRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createAttachment(request, callback)
createAttachment(request: protos.google.devtools.artifactregistry.v1.ICreateAttachmentRequest, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateAttachmentRequest
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createRepository(request, options)
createRepository(request?: protos.google.devtools.artifactregistry.v1.ICreateRepositoryRequest, options?: CallOptions): Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateRepositoryRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource where the repository will be
* created.
*/
// const parent = 'abc123'
/**
* Required. The repository id to use for this repository.
*/
// const repositoryId = 'abc123'
/**
* Required. The repository to be created.
*/
// const repository = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callCreateRepository() {
// Construct request
const request = {
parent,
repositoryId,
repository,
};
// Run request
const [operation] = await artifactregistryClient.createRepository(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateRepository();
createRepository(request, options, callback)
createRepository(request: protos.google.devtools.artifactregistry.v1.ICreateRepositoryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateRepositoryRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createRepository(request, callback)
createRepository(request: protos.google.devtools.artifactregistry.v1.ICreateRepositoryRequest, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateRepositoryRequest
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createRule(request, options)
createRule(request?: protos.google.devtools.artifactregistry.v1.ICreateRuleRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRule,
protos.google.devtools.artifactregistry.v1.ICreateRuleRequest | undefined,
{} | undefined
]>;Creates a rule.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRule,
protos.google.devtools.artifactregistry.v1.ICreateRuleRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource where the rule will be created.
*/
// const parent = 'abc123'
/**
* The rule id to use for this repository.
*/
// const ruleId = 'abc123'
/**
* The rule to be created.
*/
// const rule = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callCreateRule() {
// Construct request
const request = {
parent,
};
// Run request
const response = await artifactregistryClient.createRule(request);
console.log(response);
}
callCreateRule();
createRule(request, options, callback)
createRule(request: protos.google.devtools.artifactregistry.v1.ICreateRuleRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.ICreateRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateRuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.ICreateRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createRule(request, callback)
createRule(request: protos.google.devtools.artifactregistry.v1.ICreateRuleRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.ICreateRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateRuleRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.ICreateRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createTag(request, options)
createTag(request?: protos.google.devtools.artifactregistry.v1.ICreateTagRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.ITag,
protos.google.devtools.artifactregistry.v1.ICreateTagRequest | undefined,
{} | undefined
]>;Creates a tag.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateTagRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.ITag,
protos.google.devtools.artifactregistry.v1.ICreateTagRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Tag. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the parent resource where the tag will be created.
*/
// const parent = 'abc123'
/**
* The tag id to use for this repository.
*/
// const tagId = 'abc123'
/**
* The tag to be created.
*/
// const tag = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callCreateTag() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.createTag(request);
console.log(response);
}
callCreateTag();
createTag(request, options, callback)
createTag(request: protos.google.devtools.artifactregistry.v1.ICreateTagRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.ICreateTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateTagRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.ICreateTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
createTag(request, callback)
createTag(request: protos.google.devtools.artifactregistry.v1.ICreateTagRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.ICreateTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
ICreateTagRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.ICreateTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteAttachment(request, options)
deleteAttachment(request?: protos.google.devtools.artifactregistry.v1.IDeleteAttachmentRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes an attachment. The returned Operation will finish once the attachments has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteAttachmentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the attachment to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteAttachment() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deleteAttachment(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteAttachment();
deleteAttachment(request, options, callback)
deleteAttachment(request: protos.google.devtools.artifactregistry.v1.IDeleteAttachmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteAttachmentRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteAttachment(request, callback)
deleteAttachment(request: protos.google.devtools.artifactregistry.v1.IDeleteAttachmentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteAttachmentRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteFile(request, options)
deleteFile(request?: protos.google.devtools.artifactregistry.v1.IDeleteFileRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a file and all of its content. It is only allowed on generic repositories. The returned operation will complete once the file has been deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFileRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the file to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteFile() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deleteFile(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteFile();
deleteFile(request, options, callback)
deleteFile(request: protos.google.devtools.artifactregistry.v1.IDeleteFileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFileRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteFile(request, callback)
deleteFile(request: protos.google.devtools.artifactregistry.v1.IDeleteFileRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteFileRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteOperation(request, optionsOrCallback, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
optionsOrCallback |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
|
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<protos.google.protobuf.Empty> |
|
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deletePackage(request, options)
deletePackage(request?: protos.google.devtools.artifactregistry.v1.IDeletePackageRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeletePackageRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the package to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeletePackage() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deletePackage(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePackage();
deletePackage(request, options, callback)
deletePackage(request: protos.google.devtools.artifactregistry.v1.IDeletePackageRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeletePackageRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deletePackage(request, callback)
deletePackage(request: protos.google.devtools.artifactregistry.v1.IDeletePackageRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeletePackageRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteRepository(request, options)
deleteRepository(request?: protos.google.devtools.artifactregistry.v1.IDeleteRepositoryRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;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 | |
|---|---|
| Name | Description |
request |
IDeleteRepositoryRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the repository to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteRepository() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await artifactregistryClient.deleteRepository(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteRepository();
deleteRepository(request, options, callback)
deleteRepository(request: protos.google.devtools.artifactregistry.v1.IDeleteRepositoryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteRepositoryRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteRepository(request, callback)
deleteRepository(request: protos.google.devtools.artifactregistry.v1.IDeleteRepositoryRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteRepositoryRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteRule(request, options)
deleteRule(request?: protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest | undefined,
{} | undefined
]>;Deletes a rule.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the rule to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteRule() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.deleteRule(request);
console.log(response);
}
callDeleteRule();
deleteRule(request, options, callback)
deleteRule(request: protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteRuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteRule(request, callback)
deleteRule(request: protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteRuleRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteTag(request, options)
deleteTag(request?: protos.google.devtools.artifactregistry.v1.IDeleteTagRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.devtools.artifactregistry.v1.IDeleteTagRequest | undefined,
{} | undefined
]>;Deletes a tag.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteTagRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.devtools.artifactregistry.v1.IDeleteTagRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the tag to delete.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteTag() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.deleteTag(request);
console.log(response);
}
callDeleteTag();
deleteTag(request, options, callback)
deleteTag(request: protos.google.devtools.artifactregistry.v1.IDeleteTagRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteTagRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteTag(request, callback)
deleteTag(request: protos.google.devtools.artifactregistry.v1.IDeleteTagRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteTagRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IDeleteTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteVersion(request, options)
deleteVersion(request?: protos.google.devtools.artifactregistry.v1.IDeleteVersionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the version to delete.
*/
// const name = 'abc123'
/**
* 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.
*/
// const force = true
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callDeleteVersion() {
// Construct request
const request = {
};
// Run request
const [operation] = await artifactregistryClient.deleteVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteVersion();
deleteVersion(request, options, callback)
deleteVersion(request: protos.google.devtools.artifactregistry.v1.IDeleteVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteVersionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
deleteVersion(request, callback)
deleteVersion(request: protos.google.devtools.artifactregistry.v1.IDeleteVersionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteVersionRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.devtools.artifactregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
dockerImagePath(project, location, repository, dockerImage)
dockerImagePath(project: string, location: string, repository: string, dockerImage: string): string;Return a fully-qualified dockerImage resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
dockerImage |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
exportArtifact(request, options)
exportArtifact(request?: protos.google.devtools.artifactregistry.v1.IExportArtifactRequest, options?: CallOptions): Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IExportArtifactResponse, protos.google.devtools.artifactregistry.v1.IExportArtifactMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;Exports an artifact to a Cloud Storage bucket.
| Parameters | |
|---|---|
| Name | Description |
request |
IExportArtifactRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IExportArtifactResponse, protos.google.devtools.artifactregistry.v1.IExportArtifactMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The artifact version to export.
* Format:
* projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}
*/
// const sourceVersion = 'abc123'
/**
* The artifact tag to export.
* Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}
*/
// const sourceTag = 'abc123'
/**
* The Cloud Storage path to export the artifact to. Should start with the
* bucket name, and optionally have a directory path. Examples:
* `dst_bucket`, `dst_bucket/sub_dir`.
* Existing objects with the same path will be overwritten.
*/
// const gcsPath = 'abc123'
/**
* Required. The repository of the artifact to export.
* Format: projects/{project}/locations/{location}/repositories/{repository}
*/
// const repository = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callExportArtifact() {
// Construct request
const request = {
repository,
};
// Run request
const [operation] = await artifactregistryClient.exportArtifact(request);
const [response] = await operation.promise();
console.log(response);
}
callExportArtifact();
exportArtifact(request, options, callback)
exportArtifact(request: protos.google.devtools.artifactregistry.v1.IExportArtifactRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IExportArtifactResponse, protos.google.devtools.artifactregistry.v1.IExportArtifactMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IExportArtifactRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IExportArtifactResponse, protos.google.devtools.artifactregistry.v1.IExportArtifactMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
exportArtifact(request, callback)
exportArtifact(request: protos.google.devtools.artifactregistry.v1.IExportArtifactRequest, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IExportArtifactResponse, protos.google.devtools.artifactregistry.v1.IExportArtifactMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IExportArtifactRequest
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IExportArtifactResponse, protos.google.devtools.artifactregistry.v1.IExportArtifactMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
filePath(project, location, repository, file)
filePath(project: string, location: string, repository: string, file: string): string;Return a fully-qualified file resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
file |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
genericArtifactPath(project, location, repository, genericArtifact)
genericArtifactPath(project: string, location: string, repository: string, genericArtifact: string): string;Return a fully-qualified genericArtifact resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
genericArtifact |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
getAttachment(request, options)
getAttachment(request?: protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IAttachment,
protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest | undefined,
{} | undefined
]>;Gets an attachment.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetAttachmentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IAttachment,
protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Attachment. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the attachment to retrieve.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetAttachment() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getAttachment(request);
console.log(response);
}
callGetAttachment();
getAttachment(request, options, callback)
getAttachment(request: protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetAttachmentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getAttachment(request, callback)
getAttachment(request: protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetAttachmentRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IAttachment, protos.google.devtools.artifactregistry.v1.IGetAttachmentRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getDockerImage(request, options)
getDockerImage(request?: protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IDockerImage,
protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest | undefined,
{} | undefined
]>;Gets a docker image.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetDockerImageRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IDockerImage,
protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing DockerImage. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the docker images.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetDockerImage() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getDockerImage(request);
console.log(response);
}
callGetDockerImage();
getDockerImage(request, options, callback)
getDockerImage(request: protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IDockerImage, protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetDockerImageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IDockerImage, protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getDockerImage(request, callback)
getDockerImage(request: protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IDockerImage, protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetDockerImageRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IDockerImage, protos.google.devtools.artifactregistry.v1.IGetDockerImageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getFile(request, options)
getFile(request?: protos.google.devtools.artifactregistry.v1.IGetFileRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IFile,
protos.google.devtools.artifactregistry.v1.IGetFileRequest | undefined,
{} | undefined
]>;Gets a file.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetFileRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IFile,
protos.google.devtools.artifactregistry.v1.IGetFileRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing File. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the file to retrieve.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetFile() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getFile(request);
console.log(response);
}
callGetFile();
getFile(request, options, callback)
getFile(request: protos.google.devtools.artifactregistry.v1.IGetFileRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IGetFileRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFileRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IGetFileRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getFile(request, callback)
getFile(request: protos.google.devtools.artifactregistry.v1.IGetFileRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IGetFileRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetFileRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IGetFileRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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
]>;Gets the IAM policy for a given resource.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.IGetIamPolicyRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to
* `GetIamPolicy`.
*/
// const options = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetIamPolicy() {
// Construct request
const request = {
resource,
};
// Run request
const response = await artifactregistryClient.getIamPolicy(request);
console.log(response);
}
callGetIamPolicy();
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 | |
|---|---|
| Name | Description |
request |
IGetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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 | |
|---|---|
| Name | Description |
request |
IGetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.location.ILocation> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
const [response] = await client.getLocation(request);
getMavenArtifact(request, options)
getMavenArtifact(request?: protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IMavenArtifact,
protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest | undefined,
{} | undefined
]>;Gets a maven artifact.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetMavenArtifactRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IMavenArtifact,
protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing MavenArtifact. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the maven artifact.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetMavenArtifact() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getMavenArtifact(request);
console.log(response);
}
callGetMavenArtifact();
getMavenArtifact(request, options, callback)
getMavenArtifact(request: protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IMavenArtifact, protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMavenArtifactRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IMavenArtifact, protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getMavenArtifact(request, callback)
getMavenArtifact(request: protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IMavenArtifact, protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetMavenArtifactRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IMavenArtifact, protos.google.devtools.artifactregistry.v1.IGetMavenArtifactRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getNpmPackage(request, options)
getNpmPackage(request?: protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.INpmPackage,
protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest | undefined,
{} | undefined
]>;Gets a npm package.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetNpmPackageRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.INpmPackage,
protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing NpmPackage. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the npm package.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetNpmPackage() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getNpmPackage(request);
console.log(response);
}
callGetNpmPackage();
getNpmPackage(request, options, callback)
getNpmPackage(request: protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.INpmPackage, protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetNpmPackageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.INpmPackage, protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getNpmPackage(request, callback)
getNpmPackage(request: protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.INpmPackage, protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetNpmPackageRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.INpmPackage, protos.google.devtools.artifactregistry.v1.IGetNpmPackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getOperation(request, optionsOrCallback, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
optionsOrCallback |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
|
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
| Returns | |
|---|---|
| Type | Description |
Promise<[protos.google.longrunning.Operation]> |
|
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getPackage(request, options)
getPackage(request?: protos.google.devtools.artifactregistry.v1.IGetPackageRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IPackage,
protos.google.devtools.artifactregistry.v1.IGetPackageRequest | undefined,
{} | undefined
]>;Gets a package.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetPackageRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IPackage,
protos.google.devtools.artifactregistry.v1.IGetPackageRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Package. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the package to retrieve.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetPackage() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getPackage(request);
console.log(response);
}
callGetPackage();
getPackage(request, options, callback)
getPackage(request: protos.google.devtools.artifactregistry.v1.IGetPackageRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IGetPackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetPackageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IGetPackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getPackage(request, callback)
getPackage(request: protos.google.devtools.artifactregistry.v1.IGetPackageRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IGetPackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetPackageRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IGetPackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getProjectId()
getProjectId(): Promise<string>;| Returns | |
|---|---|
| Type | Description |
Promise<string> |
|
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;| Parameter | |
|---|---|
| Name | Description |
callback |
Callback<string, undefined, undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getProjectSettings(request, options)
getProjectSettings(request?: protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IProjectSettings,
protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest | undefined,
{} | undefined
]>;Retrieves the Settings for the Project.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetProjectSettingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IProjectSettings,
protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the projectSettings resource.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetProjectSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getProjectSettings(request);
console.log(response);
}
callGetProjectSettings();
getProjectSettings(request, options, callback)
getProjectSettings(request: protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetProjectSettingsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getProjectSettings(request, callback)
getProjectSettings(request: protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetProjectSettingsRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IGetProjectSettingsRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getPythonPackage(request, options)
getPythonPackage(request?: protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IPythonPackage,
protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest | undefined,
{} | undefined
]>;Gets a python package.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetPythonPackageRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IPythonPackage,
protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing PythonPackage. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the python package.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetPythonPackage() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getPythonPackage(request);
console.log(response);
}
callGetPythonPackage();
getPythonPackage(request, options, callback)
getPythonPackage(request: protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IPythonPackage, protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetPythonPackageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IPythonPackage, protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getPythonPackage(request, callback)
getPythonPackage(request: protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IPythonPackage, protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetPythonPackageRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IPythonPackage, protos.google.devtools.artifactregistry.v1.IGetPythonPackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getRepository(request, options)
getRepository(request?: protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRepository,
protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest | undefined,
{} | undefined
]>;Gets a repository.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetRepositoryRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRepository,
protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the repository to retrieve.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetRepository() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getRepository(request);
console.log(response);
}
callGetRepository();
getRepository(request, options, callback)
getRepository(request: protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetRepositoryRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getRepository(request, callback)
getRepository(request: protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetRepositoryRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IGetRepositoryRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getRule(request, options)
getRule(request?: protos.google.devtools.artifactregistry.v1.IGetRuleRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRule,
protos.google.devtools.artifactregistry.v1.IGetRuleRequest | undefined,
{} | undefined
]>;Gets a rule.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRule,
protos.google.devtools.artifactregistry.v1.IGetRuleRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the rule to retrieve.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetRule() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getRule(request);
console.log(response);
}
callGetRule();
getRule(request, options, callback)
getRule(request: protos.google.devtools.artifactregistry.v1.IGetRuleRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IGetRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetRuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IGetRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getRule(request, callback)
getRule(request: protos.google.devtools.artifactregistry.v1.IGetRuleRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IGetRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetRuleRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IGetRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getTag(request, options)
getTag(request?: protos.google.devtools.artifactregistry.v1.IGetTagRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.ITag,
protos.google.devtools.artifactregistry.v1.IGetTagRequest | undefined,
{} | undefined
]>;Gets a tag.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetTagRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.ITag,
protos.google.devtools.artifactregistry.v1.IGetTagRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Tag. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the tag to retrieve.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetTag() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.getTag(request);
console.log(response);
}
callGetTag();
getTag(request, options, callback)
getTag(request: protos.google.devtools.artifactregistry.v1.IGetTagRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IGetTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetTagRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IGetTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getTag(request, callback)
getTag(request: protos.google.devtools.artifactregistry.v1.IGetTagRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IGetTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetTagRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IGetTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getVersion(request, options)
getVersion(request?: protos.google.devtools.artifactregistry.v1.IGetVersionRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IVersion,
protos.google.devtools.artifactregistry.v1.IGetVersionRequest | undefined,
{} | undefined
]>;Gets a version
| Parameters | |
|---|---|
| Name | Description |
request |
IGetVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IVersion,
protos.google.devtools.artifactregistry.v1.IGetVersionRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Version. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the version to retrieve.
*/
// const name = 'abc123'
/**
* The view that should be returned in the response.
*/
// const view = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetVersion() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.getVersion(request);
console.log(response);
}
callGetVersion();
getVersion(request, options, callback)
getVersion(request: protos.google.devtools.artifactregistry.v1.IGetVersionRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IGetVersionRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IGetVersionRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getVersion(request, callback)
getVersion(request: protos.google.devtools.artifactregistry.v1.IGetVersionRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IGetVersionRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetVersionRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IGetVersionRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getVPCSCConfig(request, options)
getVPCSCConfig(request?: protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IVPCSCConfig,
protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest | undefined,
{} | undefined
]>;Retrieves the VPCSC Config for the Project.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetVPCSCConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IVPCSCConfig,
protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the VPCSCConfig resource.
*/
// const name = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callGetVPCSCConfig() {
// Construct request
const request = {
name,
};
// Run request
const response = await artifactregistryClient.getVPCSCConfig(request);
console.log(response);
}
callGetVPCSCConfig();
getVPCSCConfig(request, options, callback)
getVPCSCConfig(request: protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetVPCSCConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
getVPCSCConfig(request, callback)
getVPCSCConfig(request: protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IGetVPCSCConfigRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IGetVPCSCConfigRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
goModulePath(project, location, repository, goModule)
goModulePath(project: string, location: string, repository: string, goModule: string): string;Return a fully-qualified goModule resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
goModule |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
importAptArtifacts(request, options)
importAptArtifacts(request?: protos.google.devtools.artifactregistry.v1.IImportAptArtifactsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportAptArtifactsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;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.
| Parameters | |
|---|---|
| Name | Description |
request |
IImportAptArtifactsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportAptArtifactsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Google Cloud Storage location where input content is located.
*/
// const gcsSource = {}
/**
* The name of the parent resource where the artifacts will be imported.
*/
// const parent = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callImportAptArtifacts() {
// Construct request
const request = {
};
// Run request
const [operation] = await artifactregistryClient.importAptArtifacts(request);
const [response] = await operation.promise();
console.log(response);
}
callImportAptArtifacts();
importAptArtifacts(request, options, callback)
importAptArtifacts(request: protos.google.devtools.artifactregistry.v1.IImportAptArtifactsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportAptArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IImportAptArtifactsRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportAptArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
importAptArtifacts(request, callback)
importAptArtifacts(request: protos.google.devtools.artifactregistry.v1.IImportAptArtifactsRequest, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportAptArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IImportAptArtifactsRequest
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportAptArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportAptArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
importYumArtifacts(request, options)
importYumArtifacts(request?: protos.google.devtools.artifactregistry.v1.IImportYumArtifactsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportYumArtifactsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;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.
| Parameters | |
|---|---|
| Name | Description |
request |
IImportYumArtifactsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
LROperation<protos.google.devtools.artifactregistry.v1.IImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportYumArtifactsMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Google Cloud Storage location where input content is located.
*/
// const gcsSource = {}
/**
* The name of the parent resource where the artifacts will be imported.
*/
// const parent = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callImportYumArtifacts() {
// Construct request
const request = {
};
// Run request
const [operation] = await artifactregistryClient.importYumArtifacts(request);
const [response] = await operation.promise();
console.log(response);
}
callImportYumArtifacts();
importYumArtifacts(request, options, callback)
importYumArtifacts(request: protos.google.devtools.artifactregistry.v1.IImportYumArtifactsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportYumArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IImportYumArtifactsRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportYumArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
importYumArtifacts(request, callback)
importYumArtifacts(request: protos.google.devtools.artifactregistry.v1.IImportYumArtifactsRequest, callback: Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportYumArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IImportYumArtifactsRequest
|
callback |
Callback<LROperation<protos.google.devtools.artifactregistry.v1.IImportYumArtifactsResponse, protos.google.devtools.artifactregistry.v1.IImportYumArtifactsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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. |
kfpArtifactPath(project, location, repository, kfpArtifact)
kfpArtifactPath(project: string, location: string, repository: string, kfpArtifact: string): string;Return a fully-qualified kfpArtifact resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
kfpArtifact |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
listAttachments(request, options)
listAttachments(request?: protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IAttachment[],
protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest | null,
protos.google.devtools.artifactregistry.v1.IListAttachmentsResponse
]>;Lists attachments.
| Parameters | |
|---|---|
| Name | Description |
request |
IListAttachmentsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IAttachment[],
protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest | null,
protos.google.devtools.artifactregistry.v1.IListAttachmentsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of Attachment. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listAttachments(request, options, callback)
listAttachments(request: protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, protos.google.devtools.artifactregistry.v1.IListAttachmentsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IAttachment>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListAttachmentsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, protos.google.devtools.artifactregistry.v1.IListAttachmentsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IAttachment>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listAttachments(request, callback)
listAttachments(request: protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, protos.google.devtools.artifactregistry.v1.IListAttachmentsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IAttachment>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListAttachmentsRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, protos.google.devtools.artifactregistry.v1.IListAttachmentsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IAttachment>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listAttachmentsAsync(request, options)
listAttachmentsAsync(request?: protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.IAttachment>;Equivalent to listAttachments, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListAttachmentsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IAttachment> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Attachment. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose attachments will be listed.
*/
// const parent = 'abc123'
/**
* Optional. An expression for filtering the results of the request. Filter
* rules are case insensitive. The fields eligible for filtering are:
* * `target`
* * `type`
* * `attachment_namespace`
*/
// const filter = 'abc123'
/**
* The maximum number of attachments to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListAttachments() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listAttachmentsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAttachments();
listAttachmentsStream(request, options)
listAttachmentsStream(request?: protos.google.devtools.artifactregistry.v1.IListAttachmentsRequest, options?: CallOptions): Transform;Equivalent to listAttachments, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListAttachmentsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing Attachment 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 |
listDockerImages(request, options)
listDockerImages(request?: protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IDockerImage[],
protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListDockerImagesResponse
]>;Lists docker images.
| Parameters | |
|---|---|
| Name | Description |
request |
IListDockerImagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IDockerImage[],
protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListDockerImagesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of DockerImage. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listDockerImages(request, options, callback)
listDockerImages(request: protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, protos.google.devtools.artifactregistry.v1.IListDockerImagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IDockerImage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListDockerImagesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, protos.google.devtools.artifactregistry.v1.IListDockerImagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IDockerImage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listDockerImages(request, callback)
listDockerImages(request: protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, protos.google.devtools.artifactregistry.v1.IListDockerImagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IDockerImage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListDockerImagesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, protos.google.devtools.artifactregistry.v1.IListDockerImagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IDockerImage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listDockerImagesAsync(request, options)
listDockerImagesAsync(request?: protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.IDockerImage>;Equivalent to listDockerImages, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListDockerImagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IDockerImage> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DockerImage. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose docker images will be
* listed.
*/
// const parent = 'abc123'
/**
* The maximum number of artifacts to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
/**
* The field to order the results by.
*/
// const orderBy = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListDockerImages() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listDockerImagesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDockerImages();
listDockerImagesStream(request, options)
listDockerImagesStream(request?: protos.google.devtools.artifactregistry.v1.IListDockerImagesRequest, options?: CallOptions): Transform;Equivalent to listDockerImages, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListDockerImagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing DockerImage 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 |
listFiles(request, options)
listFiles(request?: protos.google.devtools.artifactregistry.v1.IListFilesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IFile[],
protos.google.devtools.artifactregistry.v1.IListFilesRequest | null,
protos.google.devtools.artifactregistry.v1.IListFilesResponse
]>;Lists files.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFilesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IFile[],
protos.google.devtools.artifactregistry.v1.IListFilesRequest | null,
protos.google.devtools.artifactregistry.v1.IListFilesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of File. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listFiles(request, options, callback)
listFiles(request: protos.google.devtools.artifactregistry.v1.IListFilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListFilesRequest, protos.google.devtools.artifactregistry.v1.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IFile>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFilesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListFilesRequest, protos.google.devtools.artifactregistry.v1.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IFile>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listFiles(request, callback)
listFiles(request: protos.google.devtools.artifactregistry.v1.IListFilesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListFilesRequest, protos.google.devtools.artifactregistry.v1.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IFile>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListFilesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListFilesRequest, protos.google.devtools.artifactregistry.v1.IListFilesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IFile>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listFilesAsync(request, options)
listFilesAsync(request?: protos.google.devtools.artifactregistry.v1.IListFilesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.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 | |
|---|---|
| Name | Description |
request |
IListFilesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IFile> |
{Object} An iterable Object that allows async iteration. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the repository whose files will be listed. For
* example: "projects/p1/locations/us-central1/repositories/repo1
*/
// const parent = 'abc123'
/**
* An expression for filtering the results of the request. Filter rules are
* case insensitive. The fields eligible for filtering are:
* * `name`
* * `owner`
* * `annotations`
* Examples of using a filter:
* To filter the results of your request to files with the name `my_file.txt`
* in project `my-project` in the `us-central` region, in repository
* `my-repo`, append the following filter expression to your request:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"`
* You can also use wildcards to match any number of characters before or
* after the value:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"`
* To filter the results of your request to files owned by the version `1.0`
* in package `pkg1`, append the following filter expression to your request:
* * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"`
* To filter the results of your request to files with the annotation
* key-value pair `external_link`: `external_link_value`, append the
* following filter expression to your request:
* * `"annotations.external_link:external_link_value"`
* To filter just for a specific annotation key `external_link`, append the
* following filter expression to your request:
* * `"annotations.external_link"`
* If the annotation key or value contains special characters, you can escape
* them by surrounding the value with backticks. For example, to filter the
* results of your request to files with the annotation key-value pair
* `external.link`:`https://example.com/my-file`, append the following
* filter expression to your request:
* * `` "annotations.`external.link`:`https://example.com/my-file`" ``
* You can also filter with annotations with a wildcard to
* match any number of characters before or after the value:
* * `` "annotations.*_link:`*example.com*`" ``
*/
// const filter = 'abc123'
/**
* The maximum number of files to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
/**
* The field to order the results by.
*/
// const orderBy = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListFiles() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listFilesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListFiles();
listFilesStream(request, options)
listFilesStream(request?: protos.google.devtools.artifactregistry.v1.IListFilesRequest, options?: CallOptions): Transform;Equivalent to listFiles, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListFilesRequest
The request object that will be sent. |
options |
CallOptions
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 |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;Lists information about the supported locations for this service. Returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<google.cloud.location.ILocation> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listMavenArtifacts(request, options)
listMavenArtifacts(request?: protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IMavenArtifact[],
protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest | null,
protos.google.devtools.artifactregistry.v1.IListMavenArtifactsResponse
]>;Lists maven artifacts.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMavenArtifactsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IMavenArtifact[],
protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest | null,
protos.google.devtools.artifactregistry.v1.IListMavenArtifactsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of MavenArtifact. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listMavenArtifacts(request, options, callback)
listMavenArtifacts(request: protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, protos.google.devtools.artifactregistry.v1.IListMavenArtifactsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IMavenArtifact>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMavenArtifactsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, protos.google.devtools.artifactregistry.v1.IListMavenArtifactsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IMavenArtifact>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listMavenArtifacts(request, callback)
listMavenArtifacts(request: protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, protos.google.devtools.artifactregistry.v1.IListMavenArtifactsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IMavenArtifact>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListMavenArtifactsRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, protos.google.devtools.artifactregistry.v1.IListMavenArtifactsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IMavenArtifact>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listMavenArtifactsAsync(request, options)
listMavenArtifactsAsync(request?: protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.IMavenArtifact>;Equivalent to listMavenArtifacts, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMavenArtifactsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IMavenArtifact> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing MavenArtifact. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose maven artifacts will be
* listed.
*/
// const parent = 'abc123'
/**
* The maximum number of artifacts to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListMavenArtifacts() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listMavenArtifactsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListMavenArtifacts();
listMavenArtifactsStream(request, options)
listMavenArtifactsStream(request?: protos.google.devtools.artifactregistry.v1.IListMavenArtifactsRequest, options?: CallOptions): Transform;Equivalent to listMavenArtifacts, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListMavenArtifactsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing MavenArtifact 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 |
listNpmPackages(request, options)
listNpmPackages(request?: protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.INpmPackage[],
protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListNpmPackagesResponse
]>;Lists npm packages.
| Parameters | |
|---|---|
| Name | Description |
request |
IListNpmPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.INpmPackage[],
protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListNpmPackagesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of NpmPackage. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listNpmPackages(request, options, callback)
listNpmPackages(request: protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, protos.google.devtools.artifactregistry.v1.IListNpmPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.INpmPackage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListNpmPackagesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, protos.google.devtools.artifactregistry.v1.IListNpmPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.INpmPackage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listNpmPackages(request, callback)
listNpmPackages(request: protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, protos.google.devtools.artifactregistry.v1.IListNpmPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.INpmPackage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListNpmPackagesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, protos.google.devtools.artifactregistry.v1.IListNpmPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.INpmPackage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listNpmPackagesAsync(request, options)
listNpmPackagesAsync(request?: protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.INpmPackage>;Equivalent to listNpmPackages, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListNpmPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.INpmPackage> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing NpmPackage. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose npm packages will be
* listed.
*/
// const parent = 'abc123'
/**
* The maximum number of artifacts to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListNpmPackages() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listNpmPackagesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListNpmPackages();
listNpmPackagesStream(request, options)
listNpmPackagesStream(request?: protos.google.devtools.artifactregistry.v1.IListNpmPackagesRequest, options?: CallOptions): Transform;Equivalent to listNpmPackages, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListNpmPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing NpmPackage 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 |
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.longrunning.IOperation> |
{Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listPackages(request, options)
listPackages(request?: protos.google.devtools.artifactregistry.v1.IListPackagesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IPackage[],
protos.google.devtools.artifactregistry.v1.IListPackagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListPackagesResponse
]>;Lists packages.
| Parameters | |
|---|---|
| Name | Description |
request |
IListPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IPackage[],
protos.google.devtools.artifactregistry.v1.IListPackagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListPackagesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of Package. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPackages(request, options, callback)
listPackages(request: protos.google.devtools.artifactregistry.v1.IListPackagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPackage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListPackagesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPackage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listPackages(request, callback)
listPackages(request: protos.google.devtools.artifactregistry.v1.IListPackagesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPackage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListPackagesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPackage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listPackagesAsync(request, options)
listPackagesAsync(request?: protos.google.devtools.artifactregistry.v1.IListPackagesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.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 | |
|---|---|
| Name | Description |
request |
IListPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IPackage> |
{Object} An iterable Object that allows async iteration. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose packages will be listed.
*/
// const parent = 'abc123'
/**
* The maximum number of packages to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
/**
* Optional. An expression for filtering the results of the request. Filter
* rules are case insensitive. The fields eligible for filtering are:
* * `name`
* * `annotations`
* Examples of using a filter:
* To filter the results of your request to packages with the name
* `my-package` in project `my-project` in the `us-central` region, in
* repository `my-repo`, append the following filter expression to your
* request:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"`
* You can also use wildcards to match any number of characters before or
* after the value:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"`
* To filter the results of your request to packages with the annotation
* key-value pair `external_link`: `external_link_value`, append the
* following filter expression to your request":
* * `"annotations.external_link:external_link_value"`
* To filter the results just for a specific annotation key `external_link`,
* append the following filter expression to your request:
* * `"annotations.external_link"`
* If the annotation key or value contains special characters, you can escape
* them by surrounding the value with backticks. For example, to filter the
* results of your request to packages with the annotation key-value pair
* `external.link`:`https://example.com/my-package`, append the following
* filter expression to your request:
* * `` "annotations.`external.link`:`https://example.com/my-package`" ``
* You can also filter with annotations with a wildcard to
* match any number of characters before or after the value:
* * `` "annotations.*_link:`*example.com*`" ``
*/
// const filter = 'abc123'
/**
* Optional. The field to order the results by.
*/
// const orderBy = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListPackages() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listPackagesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPackages();
listPackagesStream(request, options)
listPackagesStream(request?: protos.google.devtools.artifactregistry.v1.IListPackagesRequest, options?: CallOptions): Transform;Equivalent to listPackages, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListPackagesRequest
The request object that will be sent. |
options |
CallOptions
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 |
listPythonPackages(request, options)
listPythonPackages(request?: protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IPythonPackage[],
protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListPythonPackagesResponse
]>;Lists python packages.
| Parameters | |
|---|---|
| Name | Description |
request |
IListPythonPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IPythonPackage[],
protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest | null,
protos.google.devtools.artifactregistry.v1.IListPythonPackagesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of PythonPackage. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPythonPackages(request, options, callback)
listPythonPackages(request: protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPythonPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPythonPackage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListPythonPackagesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPythonPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPythonPackage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listPythonPackages(request, callback)
listPythonPackages(request: protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPythonPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPythonPackage>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListPythonPackagesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, protos.google.devtools.artifactregistry.v1.IListPythonPackagesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IPythonPackage>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listPythonPackagesAsync(request, options)
listPythonPackagesAsync(request?: protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.IPythonPackage>;Equivalent to listPythonPackages, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListPythonPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IPythonPackage> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing PythonPackage. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose python packages will be
* listed.
*/
// const parent = 'abc123'
/**
* The maximum number of artifacts to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListPythonPackages() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listPythonPackagesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPythonPackages();
listPythonPackagesStream(request, options)
listPythonPackagesStream(request?: protos.google.devtools.artifactregistry.v1.IListPythonPackagesRequest, options?: CallOptions): Transform;Equivalent to listPythonPackages, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListPythonPackagesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing PythonPackage 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 |
listRepositories(request, options)
listRepositories(request?: protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRepository[],
protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest | null,
protos.google.devtools.artifactregistry.v1.IListRepositoriesResponse
]>;Lists repositories.
| Parameters | |
|---|---|
| Name | Description |
request |
IListRepositoriesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRepository[],
protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest | null,
protos.google.devtools.artifactregistry.v1.IListRepositoriesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listRepositories(request, options, callback)
listRepositories(request: protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRepository>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListRepositoriesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRepository>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listRepositories(request, callback)
listRepositories(request: protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRepository>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListRepositoriesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, protos.google.devtools.artifactregistry.v1.IListRepositoriesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRepository>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listRepositoriesAsync(request, options)
listRepositoriesAsync(request?: protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.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 | |
|---|---|
| Name | Description |
request |
IListRepositoriesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IRepository> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource whose repositories will be
* listed.
*/
// const parent = 'abc123'
/**
* The maximum number of repositories to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
/**
* Optional. An expression for filtering the results of the request. Filter
* rules are case insensitive. The fields eligible for filtering are:
* * `name`
* Examples of using a filter:
* To filter the results of your request to repositories with the name
* `my-repo` in project `my-project` in the `us-central` region, append the
* following filter expression to your request:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo"`
* You can also use wildcards to match any number of characters before or
* after the value:
* * `name="projects/my-project/locations/us-central1/repositories/my-*"`
* * `name="projects/my-project/locations/us-central1/repositories/*repo"`
* * `name="projects/my-project/locations/us-central1/repositories/*repo*"`
*/
// const filter = 'abc123'
/**
* Optional. The field to order the results by.
*/
// const orderBy = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListRepositories() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listRepositoriesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRepositories();
listRepositoriesStream(request, options)
listRepositoriesStream(request?: protos.google.devtools.artifactregistry.v1.IListRepositoriesRequest, options?: CallOptions): Transform;Equivalent to listRepositories, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListRepositoriesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing 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 |
listRules(request, options)
listRules(request?: protos.google.devtools.artifactregistry.v1.IListRulesRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRule[],
protos.google.devtools.artifactregistry.v1.IListRulesRequest | null,
protos.google.devtools.artifactregistry.v1.IListRulesResponse
]>;Lists rules.
| Parameters | |
|---|---|
| Name | Description |
request |
IListRulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRule[],
protos.google.devtools.artifactregistry.v1.IListRulesRequest | null,
protos.google.devtools.artifactregistry.v1.IListRulesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listRules(request, options, callback)
listRules(request: protos.google.devtools.artifactregistry.v1.IListRulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRulesRequest, protos.google.devtools.artifactregistry.v1.IListRulesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRule>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListRulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRulesRequest, protos.google.devtools.artifactregistry.v1.IListRulesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRule>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listRules(request, callback)
listRules(request: protos.google.devtools.artifactregistry.v1.IListRulesRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRulesRequest, protos.google.devtools.artifactregistry.v1.IListRulesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRule>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListRulesRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListRulesRequest, protos.google.devtools.artifactregistry.v1.IListRulesResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IRule>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listRulesAsync(request, options)
listRulesAsync(request?: protos.google.devtools.artifactregistry.v1.IListRulesRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.IRule>;Equivalent to listRules, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Parameters | |
|---|---|
| Name | Description |
request |
IListRulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IRule> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent repository whose rules will be listed.
* For example:
* `projects/p1/locations/us-central1/repositories/repo1`.
*/
// const parent = 'abc123'
/**
* The maximum number of rules to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListRules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = artifactregistryClient.listRulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRules();
listRulesStream(request, options)
listRulesStream(request?: protos.google.devtools.artifactregistry.v1.IListRulesRequest, options?: CallOptions): Transform;Equivalent to listRules, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListRulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Transform |
{Stream} An object stream which emits an object representing 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 |
listTags(request, options)
listTags(request?: protos.google.devtools.artifactregistry.v1.IListTagsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.ITag[],
protos.google.devtools.artifactregistry.v1.IListTagsRequest | null,
protos.google.devtools.artifactregistry.v1.IListTagsResponse
]>;Lists tags.
| Parameters | |
|---|---|
| Name | Description |
request |
IListTagsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.ITag[],
protos.google.devtools.artifactregistry.v1.IListTagsRequest | null,
protos.google.devtools.artifactregistry.v1.IListTagsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of Tag. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listTags(request, options, callback)
listTags(request: protos.google.devtools.artifactregistry.v1.IListTagsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListTagsRequest, protos.google.devtools.artifactregistry.v1.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.ITag>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListTagsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListTagsRequest, protos.google.devtools.artifactregistry.v1.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.ITag>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listTags(request, callback)
listTags(request: protos.google.devtools.artifactregistry.v1.IListTagsRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListTagsRequest, protos.google.devtools.artifactregistry.v1.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.ITag>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListTagsRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListTagsRequest, protos.google.devtools.artifactregistry.v1.IListTagsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.ITag>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listTagsAsync(request, options)
listTagsAsync(request?: protos.google.devtools.artifactregistry.v1.IListTagsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.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 | |
|---|---|
| Name | Description |
request |
IListTagsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.ITag> |
{Object} An iterable Object that allows async iteration. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the parent package whose tags will be listed.
* For example:
* `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`.
*/
// const parent = 'abc123'
/**
* An expression for filtering the results of the request. Filter rules are
* case insensitive. The fields eligible for filtering are:
* * `name`
* * `version`
* Examples of using a filter:
* To filter the results of your request to tags with the name `my-tag` in
* package `my-package` in repository `my-repo` in project "`y-project` in
* the us-central region, append the following filter expression to your
* request:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"`
* You can also use wildcards to match any number of characters before or
* after the value:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"`
* To filter the results of your request to tags applied to the version
* `1.0` in package `my-package`, append the following filter expression to
* your request:
* * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"`
*/
// const filter = 'abc123'
/**
* The maximum number of tags to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListTags() {
// Construct request
const request = {
};
// Run request
const iterable = artifactregistryClient.listTagsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListTags();
listTagsStream(request, options)
listTagsStream(request?: protos.google.devtools.artifactregistry.v1.IListTagsRequest, options?: CallOptions): Transform;Equivalent to listTags, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListTagsRequest
The request object that will be sent. |
options |
CallOptions
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 |
listVersions(request, options)
listVersions(request?: protos.google.devtools.artifactregistry.v1.IListVersionsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IVersion[],
protos.google.devtools.artifactregistry.v1.IListVersionsRequest | null,
protos.google.devtools.artifactregistry.v1.IListVersionsResponse
]>;Lists versions.
| Parameters | |
|---|---|
| Name | Description |
request |
IListVersionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IVersion[],
protos.google.devtools.artifactregistry.v1.IListVersionsRequest | null,
protos.google.devtools.artifactregistry.v1.IListVersionsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of Version. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listVersions(request, options, callback)
listVersions(request: protos.google.devtools.artifactregistry.v1.IListVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListVersionsRequest, protos.google.devtools.artifactregistry.v1.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IVersion>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListVersionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListVersionsRequest, protos.google.devtools.artifactregistry.v1.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IVersion>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listVersions(request, callback)
listVersions(request: protos.google.devtools.artifactregistry.v1.IListVersionsRequest, callback: PaginationCallback<protos.google.devtools.artifactregistry.v1.IListVersionsRequest, protos.google.devtools.artifactregistry.v1.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IVersion>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IListVersionsRequest
|
callback |
PaginationCallback<protos.google.devtools.artifactregistry.v1.IListVersionsRequest, protos.google.devtools.artifactregistry.v1.IListVersionsResponse | null | undefined, protos.google.devtools.artifactregistry.v1.IVersion>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
listVersionsAsync(request, options)
listVersionsAsync(request?: protos.google.devtools.artifactregistry.v1.IListVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.artifactregistry.v1.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 | |
|---|---|
| Name | Description |
request |
IListVersionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
AsyncIterable<protos.google.devtools.artifactregistry.v1.IVersion> |
{Object} An iterable Object that allows async iteration. 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 for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the parent resource whose versions will be listed.
*/
// const parent = 'abc123'
/**
* The maximum number of versions to return. Maximum page size is 1,000.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous list request, if any.
*/
// const pageToken = 'abc123'
/**
* The view that should be returned in the response.
*/
// const view = {}
/**
* Optional. The field to order the results by.
*/
// const orderBy = 'abc123'
/**
* Optional. An expression for filtering the results of the request. Filter
* rules are case insensitive. The fields eligible for filtering are:
* * `name`
* * `annotations`
* Examples of using a filter:
* To filter the results of your request to versions with the name
* `my-version` in project `my-project` in the `us-central` region, in
* repository `my-repo`, append the following filter expression to your
* request:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"`
* You can also use wildcards to match any number of characters before or
* after the value:
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"`
* * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*"`
* To filter the results of your request to versions with the annotation
* key-value pair `external_link`: `external_link_value`, append the
* following filter expression to your request:
* * `"annotations.external_link:external_link_value"`
* To filter just for a specific annotation key `external_link`, append the
* following filter expression to your request:
* * `"annotations.external_link"`
* If the annotation key or value contains special characters, you can escape
* them by surrounding the value with backticks. For example, to filter the
* results of your request to versions with the annotation key-value pair
* `external.link`:`https://example.com/my-version`, append the following
* filter expression to your request:
* * `` "annotations.`external.link`:`https://example.com/my-version`" ``
* You can also filter with annotations with a wildcard to
* match any number of characters before or after the value:
* * `` "annotations.*_link:`*example.com*`" ``
*/
// const filter = 'abc123'
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callListVersions() {
// Construct request
const request = {
};
// Run request
const iterable = artifactregistryClient.listVersionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListVersions();
listVersionsStream(request, options)
listVersionsStream(request?: protos.google.devtools.artifactregistry.v1.IListVersionsRequest, options?: CallOptions): Transform;Equivalent to listVersions, but returns a NodeJS Stream object.
| Parameters | |
|---|---|
| Name | Description |
request |
IListVersionsRequest
The request object that will be sent. |
options |
CallOptions
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 |
matchAptArtifactFromAptArtifactName(aptArtifactName)
matchAptArtifactFromAptArtifactName(aptArtifactName: string): string | number;Parse the apt_artifact from AptArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
aptArtifactName |
string
A fully-qualified path representing AptArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the apt_artifact. |
matchAttachmentFromAttachmentName(attachmentName)
matchAttachmentFromAttachmentName(attachmentName: string): string | number;Parse the attachment from Attachment resource.
| Parameter | |
|---|---|
| Name | Description |
attachmentName |
string
A fully-qualified path representing Attachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the attachment. |
matchDockerImageFromDockerImageName(dockerImageName)
matchDockerImageFromDockerImageName(dockerImageName: string): string | number;Parse the docker_image from DockerImage resource.
| Parameter | |
|---|---|
| Name | Description |
dockerImageName |
string
A fully-qualified path representing DockerImage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the docker_image. |
matchFileFromFileName(fileName)
matchFileFromFileName(fileName: string): string | number;Parse the file from File resource.
| Parameter | |
|---|---|
| Name | Description |
fileName |
string
A fully-qualified path representing File resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the file. |
matchGenericArtifactFromGenericArtifactName(genericArtifactName)
matchGenericArtifactFromGenericArtifactName(genericArtifactName: string): string | number;Parse the generic_artifact from GenericArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
genericArtifactName |
string
A fully-qualified path representing GenericArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the generic_artifact. |
matchGoModuleFromGoModuleName(goModuleName)
matchGoModuleFromGoModuleName(goModuleName: string): string | number;Parse the go_module from GoModule resource.
| Parameter | |
|---|---|
| Name | Description |
goModuleName |
string
A fully-qualified path representing GoModule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the go_module. |
matchKfpArtifactFromKfpArtifactName(kfpArtifactName)
matchKfpArtifactFromKfpArtifactName(kfpArtifactName: string): string | number;Parse the kfp_artifact from KfpArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
kfpArtifactName |
string
A fully-qualified path representing KfpArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the kfp_artifact. |
matchLocationFromAptArtifactName(aptArtifactName)
matchLocationFromAptArtifactName(aptArtifactName: string): string | number;Parse the location from AptArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
aptArtifactName |
string
A fully-qualified path representing AptArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAttachmentName(attachmentName)
matchLocationFromAttachmentName(attachmentName: string): string | number;Parse the location from Attachment resource.
| Parameter | |
|---|---|
| Name | Description |
attachmentName |
string
A fully-qualified path representing Attachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromDockerImageName(dockerImageName)
matchLocationFromDockerImageName(dockerImageName: string): string | number;Parse the location from DockerImage resource.
| Parameter | |
|---|---|
| Name | Description |
dockerImageName |
string
A fully-qualified path representing DockerImage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromFileName(fileName)
matchLocationFromFileName(fileName: string): string | number;Parse the location from File resource.
| Parameter | |
|---|---|
| Name | Description |
fileName |
string
A fully-qualified path representing File resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromGenericArtifactName(genericArtifactName)
matchLocationFromGenericArtifactName(genericArtifactName: string): string | number;Parse the location from GenericArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
genericArtifactName |
string
A fully-qualified path representing GenericArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromGoModuleName(goModuleName)
matchLocationFromGoModuleName(goModuleName: string): string | number;Parse the location from GoModule resource.
| Parameter | |
|---|---|
| Name | Description |
goModuleName |
string
A fully-qualified path representing GoModule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromKfpArtifactName(kfpArtifactName)
matchLocationFromKfpArtifactName(kfpArtifactName: string): string | number;Parse the location from KfpArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
kfpArtifactName |
string
A fully-qualified path representing KfpArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromMavenArtifactName(mavenArtifactName)
matchLocationFromMavenArtifactName(mavenArtifactName: string): string | number;Parse the location from MavenArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
mavenArtifactName |
string
A fully-qualified path representing MavenArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromNpmPackageName(npmPackageName)
matchLocationFromNpmPackageName(npmPackageName: string): string | number;Parse the location from NpmPackage resource.
| Parameter | |
|---|---|
| Name | Description |
npmPackageName |
string
A fully-qualified path representing NpmPackage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromPackageName(packageName)
matchLocationFromPackageName(packageName: string): string | number;Parse the location from Package resource.
| Parameter | |
|---|---|
| Name | Description |
packageName |
string
A fully-qualified path representing Package resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromPythonPackageName(pythonPackageName)
matchLocationFromPythonPackageName(pythonPackageName: string): string | number;Parse the location from PythonPackage resource.
| Parameter | |
|---|---|
| Name | Description |
pythonPackageName |
string
A fully-qualified path representing PythonPackage 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 | |
|---|---|
| Name | Description |
repositoryName |
string
A fully-qualified path representing Repository resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromRuleName(ruleName)
matchLocationFromRuleName(ruleName: string): string | number;Parse the location from Rule resource.
| Parameter | |
|---|---|
| Name | Description |
ruleName |
string
A fully-qualified path representing Rule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromTagName(tagName)
matchLocationFromTagName(tagName: string): string | number;Parse the location from Tag resource.
| Parameter | |
|---|---|
| Name | Description |
tagName |
string
A fully-qualified path representing Tag resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromVersionName(versionName)
matchLocationFromVersionName(versionName: string): string | number;Parse the location from Version resource.
| Parameter | |
|---|---|
| Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromVpcscConfigName(vpcscConfigName)
matchLocationFromVpcscConfigName(vpcscConfigName: string): string | number;Parse the location from VpcscConfig resource.
| Parameter | |
|---|---|
| Name | Description |
vpcscConfigName |
string
A fully-qualified path representing VpcscConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromYumArtifactName(yumArtifactName)
matchLocationFromYumArtifactName(yumArtifactName: string): string | number;Parse the location from YumArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
yumArtifactName |
string
A fully-qualified path representing YumArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the location. |
matchMavenArtifactFromMavenArtifactName(mavenArtifactName)
matchMavenArtifactFromMavenArtifactName(mavenArtifactName: string): string | number;Parse the maven_artifact from MavenArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
mavenArtifactName |
string
A fully-qualified path representing MavenArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the maven_artifact. |
matchNpmPackageFromNpmPackageName(npmPackageName)
matchNpmPackageFromNpmPackageName(npmPackageName: string): string | number;Parse the npm_package from NpmPackage resource.
| Parameter | |
|---|---|
| Name | Description |
npmPackageName |
string
A fully-qualified path representing NpmPackage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the npm_package. |
matchPackageFromPackageName(packageName)
matchPackageFromPackageName(packageName: string): string | number;Parse the package from Package resource.
| Parameter | |
|---|---|
| Name | Description |
packageName |
string
A fully-qualified path representing Package resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the package. |
matchPackageFromTagName(tagName)
matchPackageFromTagName(tagName: string): string | number;Parse the package from Tag resource.
| Parameter | |
|---|---|
| Name | Description |
tagName |
string
A fully-qualified path representing Tag resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the package. |
matchPackageFromVersionName(versionName)
matchPackageFromVersionName(versionName: string): string | number;Parse the package from Version resource.
| Parameter | |
|---|---|
| Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the package. |
matchProjectFromAptArtifactName(aptArtifactName)
matchProjectFromAptArtifactName(aptArtifactName: string): string | number;Parse the project from AptArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
aptArtifactName |
string
A fully-qualified path representing AptArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAttachmentName(attachmentName)
matchProjectFromAttachmentName(attachmentName: string): string | number;Parse the project from Attachment resource.
| Parameter | |
|---|---|
| Name | Description |
attachmentName |
string
A fully-qualified path representing Attachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromDockerImageName(dockerImageName)
matchProjectFromDockerImageName(dockerImageName: string): string | number;Parse the project from DockerImage resource.
| Parameter | |
|---|---|
| Name | Description |
dockerImageName |
string
A fully-qualified path representing DockerImage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromFileName(fileName)
matchProjectFromFileName(fileName: string): string | number;Parse the project from File resource.
| Parameter | |
|---|---|
| Name | Description |
fileName |
string
A fully-qualified path representing File resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromGenericArtifactName(genericArtifactName)
matchProjectFromGenericArtifactName(genericArtifactName: string): string | number;Parse the project from GenericArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
genericArtifactName |
string
A fully-qualified path representing GenericArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromGoModuleName(goModuleName)
matchProjectFromGoModuleName(goModuleName: string): string | number;Parse the project from GoModule resource.
| Parameter | |
|---|---|
| Name | Description |
goModuleName |
string
A fully-qualified path representing GoModule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromKfpArtifactName(kfpArtifactName)
matchProjectFromKfpArtifactName(kfpArtifactName: string): string | number;Parse the project from KfpArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
kfpArtifactName |
string
A fully-qualified path representing KfpArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromMavenArtifactName(mavenArtifactName)
matchProjectFromMavenArtifactName(mavenArtifactName: string): string | number;Parse the project from MavenArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
mavenArtifactName |
string
A fully-qualified path representing MavenArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromNpmPackageName(npmPackageName)
matchProjectFromNpmPackageName(npmPackageName: string): string | number;Parse the project from NpmPackage resource.
| Parameter | |
|---|---|
| Name | Description |
npmPackageName |
string
A fully-qualified path representing NpmPackage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromPackageName(packageName)
matchProjectFromPackageName(packageName: string): string | number;Parse the project from Package resource.
| Parameter | |
|---|---|
| Name | Description |
packageName |
string
A fully-qualified path representing Package resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectSettingsName(projectSettingsName)
matchProjectFromProjectSettingsName(projectSettingsName: string): string | number;Parse the project from ProjectSettings resource.
| Parameter | |
|---|---|
| Name | Description |
projectSettingsName |
string
A fully-qualified path representing ProjectSettings resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromPythonPackageName(pythonPackageName)
matchProjectFromPythonPackageName(pythonPackageName: string): string | number;Parse the project from PythonPackage resource.
| Parameter | |
|---|---|
| Name | Description |
pythonPackageName |
string
A fully-qualified path representing PythonPackage 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 | |
|---|---|
| Name | Description |
repositoryName |
string
A fully-qualified path representing Repository resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromRuleName(ruleName)
matchProjectFromRuleName(ruleName: string): string | number;Parse the project from Rule resource.
| Parameter | |
|---|---|
| Name | Description |
ruleName |
string
A fully-qualified path representing Rule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromTagName(tagName)
matchProjectFromTagName(tagName: string): string | number;Parse the project from Tag resource.
| Parameter | |
|---|---|
| Name | Description |
tagName |
string
A fully-qualified path representing Tag resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromVersionName(versionName)
matchProjectFromVersionName(versionName: string): string | number;Parse the project from Version resource.
| Parameter | |
|---|---|
| Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromVpcscConfigName(vpcscConfigName)
matchProjectFromVpcscConfigName(vpcscConfigName: string): string | number;Parse the project from VpcscConfig resource.
| Parameter | |
|---|---|
| Name | Description |
vpcscConfigName |
string
A fully-qualified path representing VpcscConfig resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromYumArtifactName(yumArtifactName)
matchProjectFromYumArtifactName(yumArtifactName: string): string | number;Parse the project from YumArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
yumArtifactName |
string
A fully-qualified path representing YumArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the project. |
matchPythonPackageFromPythonPackageName(pythonPackageName)
matchPythonPackageFromPythonPackageName(pythonPackageName: string): string | number;Parse the python_package from PythonPackage resource.
| Parameter | |
|---|---|
| Name | Description |
pythonPackageName |
string
A fully-qualified path representing PythonPackage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the python_package. |
matchRepositoryFromAptArtifactName(aptArtifactName)
matchRepositoryFromAptArtifactName(aptArtifactName: string): string | number;Parse the repository from AptArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
aptArtifactName |
string
A fully-qualified path representing AptArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromAttachmentName(attachmentName)
matchRepositoryFromAttachmentName(attachmentName: string): string | number;Parse the repository from Attachment resource.
| Parameter | |
|---|---|
| Name | Description |
attachmentName |
string
A fully-qualified path representing Attachment resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromDockerImageName(dockerImageName)
matchRepositoryFromDockerImageName(dockerImageName: string): string | number;Parse the repository from DockerImage resource.
| Parameter | |
|---|---|
| Name | Description |
dockerImageName |
string
A fully-qualified path representing DockerImage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromFileName(fileName)
matchRepositoryFromFileName(fileName: string): string | number;Parse the repository from File resource.
| Parameter | |
|---|---|
| Name | Description |
fileName |
string
A fully-qualified path representing File resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromGenericArtifactName(genericArtifactName)
matchRepositoryFromGenericArtifactName(genericArtifactName: string): string | number;Parse the repository from GenericArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
genericArtifactName |
string
A fully-qualified path representing GenericArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromGoModuleName(goModuleName)
matchRepositoryFromGoModuleName(goModuleName: string): string | number;Parse the repository from GoModule resource.
| Parameter | |
|---|---|
| Name | Description |
goModuleName |
string
A fully-qualified path representing GoModule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromKfpArtifactName(kfpArtifactName)
matchRepositoryFromKfpArtifactName(kfpArtifactName: string): string | number;Parse the repository from KfpArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
kfpArtifactName |
string
A fully-qualified path representing KfpArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromMavenArtifactName(mavenArtifactName)
matchRepositoryFromMavenArtifactName(mavenArtifactName: string): string | number;Parse the repository from MavenArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
mavenArtifactName |
string
A fully-qualified path representing MavenArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromNpmPackageName(npmPackageName)
matchRepositoryFromNpmPackageName(npmPackageName: string): string | number;Parse the repository from NpmPackage resource.
| Parameter | |
|---|---|
| Name | Description |
npmPackageName |
string
A fully-qualified path representing NpmPackage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromPackageName(packageName)
matchRepositoryFromPackageName(packageName: string): string | number;Parse the repository from Package resource.
| Parameter | |
|---|---|
| Name | Description |
packageName |
string
A fully-qualified path representing Package resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromPythonPackageName(pythonPackageName)
matchRepositoryFromPythonPackageName(pythonPackageName: string): string | number;Parse the repository from PythonPackage resource.
| Parameter | |
|---|---|
| Name | Description |
pythonPackageName |
string
A fully-qualified path representing PythonPackage resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromRepositoryName(repositoryName)
matchRepositoryFromRepositoryName(repositoryName: string): string | number;Parse the repository from Repository resource.
| Parameter | |
|---|---|
| Name | Description |
repositoryName |
string
A fully-qualified path representing Repository resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromRuleName(ruleName)
matchRepositoryFromRuleName(ruleName: string): string | number;Parse the repository from Rule resource.
| Parameter | |
|---|---|
| Name | Description |
ruleName |
string
A fully-qualified path representing Rule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromTagName(tagName)
matchRepositoryFromTagName(tagName: string): string | number;Parse the repository from Tag resource.
| Parameter | |
|---|---|
| Name | Description |
tagName |
string
A fully-qualified path representing Tag resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromVersionName(versionName)
matchRepositoryFromVersionName(versionName: string): string | number;Parse the repository from Version resource.
| Parameter | |
|---|---|
| Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRepositoryFromYumArtifactName(yumArtifactName)
matchRepositoryFromYumArtifactName(yumArtifactName: string): string | number;Parse the repository from YumArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
yumArtifactName |
string
A fully-qualified path representing YumArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the repository. |
matchRuleFromRuleName(ruleName)
matchRuleFromRuleName(ruleName: string): string | number;Parse the rule from Rule resource.
| Parameter | |
|---|---|
| Name | Description |
ruleName |
string
A fully-qualified path representing Rule resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the rule. |
matchTagFromTagName(tagName)
matchTagFromTagName(tagName: string): string | number;Parse the tag from Tag resource.
| Parameter | |
|---|---|
| Name | Description |
tagName |
string
A fully-qualified path representing Tag resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the tag. |
matchVersionFromVersionName(versionName)
matchVersionFromVersionName(versionName: string): string | number;Parse the version from Version resource.
| Parameter | |
|---|---|
| Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the version. |
matchYumArtifactFromYumArtifactName(yumArtifactName)
matchYumArtifactFromYumArtifactName(yumArtifactName: string): string | number;Parse the yum_artifact from YumArtifact resource.
| Parameter | |
|---|---|
| Name | Description |
yumArtifactName |
string
A fully-qualified path representing YumArtifact resource. |
| Returns | |
|---|---|
| Type | Description |
string | number |
{string} A string representing the yum_artifact. |
mavenArtifactPath(project, location, repository, mavenArtifact)
mavenArtifactPath(project: string, location: string, repository: string, mavenArtifact: string): string;Return a fully-qualified mavenArtifact resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
mavenArtifact |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
npmPackagePath(project, location, repository, npmPackage)
npmPackagePath(project: string, location: string, repository: string, npmPackage: string): string;Return a fully-qualified npmPackage resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
npmPackage |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
packagePath(project, location, repository, packageParam)
packagePath(project: string, location: string, repository: string, packageParam: string): string;Return a fully-qualified package resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
packageParam |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
projectSettingsPath(project)
projectSettingsPath(project: string): string;Return a fully-qualified projectSettings resource name string.
| Parameter | |
|---|---|
| Name | Description |
project |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
pythonPackagePath(project, location, repository, pythonPackage)
pythonPackagePath(project: string, location: string, repository: string, pythonPackage: string): string;Return a fully-qualified pythonPackage resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
pythonPackage |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
repositoryPath(project, location, repository)
repositoryPath(project: string, location: string, repository: string): string;Return a fully-qualified repository resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
rulePath(project, location, repository, rule)
rulePath(project: string, location: string, repository: string, rule: string): string;Return a fully-qualified rule resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
rule |
string
|
| 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
]>;Updates the IAM policy for a given resource.
| Parameters | |
|---|---|
| Name | Description |
request |
ISetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.ISetIamPolicyRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* 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.
*/
// const policy = {}
/**
* 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"`
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callSetIamPolicy() {
// Construct request
const request = {
resource,
policy,
};
// Run request
const response = await artifactregistryClient.setIamPolicy(request);
console.log(response);
}
callSetIamPolicy();
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 | |
|---|---|
| Name | Description |
request |
ISetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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 | |
|---|---|
| Name | Description |
request |
ISetIamPolicyRequest
|
callback |
Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
tagPath(project, location, repository, packageParam, tag)
tagPath(project: string, location: string, repository: string, packageParam: string, tag: string): string;Return a fully-qualified tag resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
packageParam |
string
|
tag |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
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
]>;Tests if the caller has a list of permissions on a resource.
| Parameters | |
|---|---|
| Name | Description |
request |
ITestIamPermissionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.iam.v1.ITestIamPermissionsResponse,
protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
*/
// const permissions = ['abc','def']
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callTestIamPermissions() {
// Construct request
const request = {
resource,
permissions,
};
// Run request
const response = await artifactregistryClient.testIamPermissions(request);
console.log(response);
}
callTestIamPermissions();
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 | |
|---|---|
| Name | Description |
request |
ITestIamPermissionsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
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 | |
|---|---|
| Name | Description |
request |
ITestIamPermissionsRequest
|
callback |
Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateFile(request, options)
updateFile(request?: protos.google.devtools.artifactregistry.v1.IUpdateFileRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IFile,
protos.google.devtools.artifactregistry.v1.IUpdateFileRequest | undefined,
{} | undefined
]>;Updates a file.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFileRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IFile,
protos.google.devtools.artifactregistry.v1.IUpdateFileRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing File. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The File that replaces the resource on the server.
*/
// const file = {}
/**
* Required. The update mask applies to the resource. For the `FieldMask`
* definition, see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateFile() {
// Construct request
const request = {
file,
updateMask,
};
// Run request
const response = await artifactregistryClient.updateFile(request);
console.log(response);
}
callUpdateFile();
updateFile(request, options, callback)
updateFile(request: protos.google.devtools.artifactregistry.v1.IUpdateFileRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IUpdateFileRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFileRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IUpdateFileRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateFile(request, callback)
updateFile(request: protos.google.devtools.artifactregistry.v1.IUpdateFileRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IUpdateFileRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateFileRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IFile, protos.google.devtools.artifactregistry.v1.IUpdateFileRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updatePackage(request, options)
updatePackage(request?: protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IPackage,
protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest | undefined,
{} | undefined
]>;Updates a package.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdatePackageRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IPackage,
protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Package. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The package that replaces the resource on the server.
*/
// const package = {}
/**
* The update mask applies to the resource. For the `FieldMask` definition,
* see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdatePackage() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.updatePackage(request);
console.log(response);
}
callUpdatePackage();
updatePackage(request, options, callback)
updatePackage(request: protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdatePackageRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updatePackage(request, callback)
updatePackage(request: protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdatePackageRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IPackage, protos.google.devtools.artifactregistry.v1.IUpdatePackageRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateProjectSettings(request, options)
updateProjectSettings(request?: protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IProjectSettings,
protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest | undefined,
{} | undefined
]>;Updates the Settings for the Project.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateProjectSettingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IProjectSettings,
protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The project settings.
*/
// const projectSettings = {}
/**
* Field mask to support partial updates.
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateProjectSettings() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.updateProjectSettings(request);
console.log(response);
}
callUpdateProjectSettings();
updateProjectSettings(request, options, callback)
updateProjectSettings(request: protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateProjectSettingsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateProjectSettings(request, callback)
updateProjectSettings(request: protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateProjectSettingsRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IProjectSettings, protos.google.devtools.artifactregistry.v1.IUpdateProjectSettingsRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateRepository(request, options)
updateRepository(request?: protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRepository,
protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest | undefined,
{} | undefined
]>;Updates a repository.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateRepositoryRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRepository,
protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The repository that replaces the resource on the server.
*/
// const repository = {}
/**
* The update mask applies to the resource. For the `FieldMask` definition,
* see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateRepository() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.updateRepository(request);
console.log(response);
}
callUpdateRepository();
updateRepository(request, options, callback)
updateRepository(request: protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateRepositoryRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateRepository(request, callback)
updateRepository(request: protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateRepositoryRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRepository, protos.google.devtools.artifactregistry.v1.IUpdateRepositoryRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateRule(request, options)
updateRule(request?: protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IRule,
protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest | undefined,
{} | undefined
]>;Updates a rule.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IRule,
protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The rule that replaces the resource on the server.
*/
// const rule = {}
/**
* The update mask applies to the resource. For the `FieldMask` definition,
* see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateRule() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.updateRule(request);
console.log(response);
}
callUpdateRule();
updateRule(request, options, callback)
updateRule(request: protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateRuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateRule(request, callback)
updateRule(request: protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateRuleRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IRule, protos.google.devtools.artifactregistry.v1.IUpdateRuleRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateTag(request, options)
updateTag(request?: protos.google.devtools.artifactregistry.v1.IUpdateTagRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.ITag,
protos.google.devtools.artifactregistry.v1.IUpdateTagRequest | undefined,
{} | undefined
]>;Updates a tag.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateTagRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.ITag,
protos.google.devtools.artifactregistry.v1.IUpdateTagRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Tag. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The tag that replaces the resource on the server.
*/
// const tag = {}
/**
* The update mask applies to the resource. For the `FieldMask` definition,
* see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateTag() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.updateTag(request);
console.log(response);
}
callUpdateTag();
updateTag(request, options, callback)
updateTag(request: protos.google.devtools.artifactregistry.v1.IUpdateTagRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IUpdateTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateTagRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IUpdateTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateTag(request, callback)
updateTag(request: protos.google.devtools.artifactregistry.v1.IUpdateTagRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IUpdateTagRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateTagRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.ITag, protos.google.devtools.artifactregistry.v1.IUpdateTagRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateVersion(request, options)
updateVersion(request?: protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IVersion,
protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest | undefined,
{} | undefined
]>;Updates a version.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IVersion,
protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Version. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Version that replaces the resource on the server.
*/
// const version = {}
/**
* The update mask applies to the resource. For the `FieldMask` definition,
* see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateVersion() {
// Construct request
const request = {
version,
};
// Run request
const response = await artifactregistryClient.updateVersion(request);
console.log(response);
}
callUpdateVersion();
updateVersion(request, options, callback)
updateVersion(request: protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateVersion(request, callback)
updateVersion(request: protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateVersionRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVersion, protos.google.devtools.artifactregistry.v1.IUpdateVersionRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateVPCSCConfig(request, options)
updateVPCSCConfig(request?: protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest, options?: CallOptions): Promise<[
protos.google.devtools.artifactregistry.v1.IVPCSCConfig,
protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest | undefined,
{} | undefined
]>;Updates the VPCSC Config for the Project.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateVPCSCConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
| Returns | |
|---|---|
| Type | Description |
Promise<[
protos.google.devtools.artifactregistry.v1.IVPCSCConfig,
protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The project config.
*/
// const vpcscConfig = {}
/**
* Field mask to support partial updates.
*/
// const updateMask = {}
// Imports the Artifactregistry library
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry').v1;
// Instantiates a client
const artifactregistryClient = new ArtifactRegistryClient();
async function callUpdateVPCSCConfig() {
// Construct request
const request = {
};
// Run request
const response = await artifactregistryClient.updateVPCSCConfig(request);
console.log(response);
}
callUpdateVPCSCConfig();
updateVPCSCConfig(request, options, callback)
updateVPCSCConfig(request: protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest, options: CallOptions, callback: Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateVPCSCConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
updateVPCSCConfig(request, callback)
updateVPCSCConfig(request: protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest, callback: Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest | null | undefined, {} | null | undefined>): void;| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateVPCSCConfigRequest
|
callback |
Callback<protos.google.devtools.artifactregistry.v1.IVPCSCConfig, protos.google.devtools.artifactregistry.v1.IUpdateVPCSCConfigRequest | null | undefined, {} | null | undefined>
|
| Returns | |
|---|---|
| Type | Description |
void |
|
versionPath(project, location, repository, packageParam, version)
versionPath(project: string, location: string, repository: string, packageParam: string, version: string): string;Return a fully-qualified version resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
packageParam |
string
|
version |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
vpcscConfigPath(project, location)
vpcscConfigPath(project: string, location: string): string;Return a fully-qualified vpcscConfig resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |
yumArtifactPath(project, location, repository, yumArtifact)
yumArtifactPath(project: string, location: string, repository: string, yumArtifact: string): string;Return a fully-qualified yumArtifact resource name string.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
repository |
string
|
yumArtifact |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
{string} Resource name string. |