ArtifactRegistryClient

ArtifactRegistryClient

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.

Constructor

new ArtifactRegistryClient(optionsopt, gaxInstanceopt)

Construct an instance of ArtifactRegistryClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ArtifactRegistryClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

aptArtifactPath(project, location, repository, apt_artifact) → {string}

Return a fully-qualified aptArtifact resource name string.

Parameters:
Name Type Description
project string
location string
repository string
apt_artifact string
Returns:
Type Description
string

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

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 Operations.GetOperation 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkBatchDeleteVersionsProgress(name) → {Promise}

Check the status of the long running operation returned by batchDeleteVersions().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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.
   *  A maximum of 10000 versions can be deleted in a batch.
   */
  // 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();

(async) checkCreateRepositoryProgress(name) → {Promise}

Check the status of the long running operation returned by createRepository().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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();

(async) checkDeletePackageProgress(name) → {Promise}

Check the status of the long running operation returned by deletePackage().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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();

(async) checkDeleteRepositoryProgress(name) → {Promise}

Check the status of the long running operation returned by deleteRepository().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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();

(async) checkDeleteVersionProgress(name) → {Promise}

Check the status of the long running operation returned by deleteVersion().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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();

(async) checkImportAptArtifactsProgress(name) → {Promise}

Check the status of the long running operation returned by importAptArtifacts().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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();

(async) checkImportYumArtifactsProgress(name) → {Promise}

Check the status of the long running operation returned by importYumArtifacts().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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.
Example
  /**
   * 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() → {Promise}

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

A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

dockerImagePath(project, location, repository, docker_image) → {string}

Return a fully-qualified dockerImage resource name string.

Parameters:
Name Type Description
project string
location string
repository string
docker_image string
Returns:
Type Description
string

Resource name string.

filePath(project, location, repository, file) → {string}

Return a fully-qualified file resource name string.

Parameters:
Name Type Description
project string
location string
repository string
file string
Returns:
Type Description
string

Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listDockerImagesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose docker images will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
orderBy string

The field to order the results by.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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.
   */
  // 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 = await artifactregistryClient.listDockerImagesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDockerImages();

listDockerImagesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose docker images will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
orderBy string

The field to order the results by.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 listDockerImagesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFilesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
filter string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `name`
* `owner`

An example of using a filter:

* `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an
ID starting with "a/b/".
* `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` -->
Files owned by the version `1.0` in package `pkg1`.
pageSize number

The maximum number of files to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
orderBy string

The field to order the results by.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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`
   *   An example of using a filter:
   *    * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an
   *    ID starting with "a/b/".
   *    * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` -->
   *    Files owned by the version `1.0` in package `pkg1`.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of files to return.
   */
  // 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 = await artifactregistryClient.listFilesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListFiles();

listFilesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
filter string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `name`
* `owner`

An example of using a filter:

* `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an
ID starting with "a/b/".
* `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` -->
Files owned by the version `1.0` in package `pkg1`.
pageSize number

The maximum number of files to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
orderBy string

The field to order the results by.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing File on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFilesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listMavenArtifactsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose maven artifacts will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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.
   */
  // 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 = await artifactregistryClient.listMavenArtifactsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMavenArtifacts();

listMavenArtifactsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose maven artifacts will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 listMavenArtifactsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNpmPackagesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose npm packages will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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.
   */
  // 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 = await artifactregistryClient.listNpmPackagesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListNpmPackages();

listNpmPackagesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose npm packages will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 listNpmPackagesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

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
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

listPackagesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose packages will be listed.
pageSize number

The maximum number of packages to return. Maximum page size is 1,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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'

  // 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 = await artifactregistryClient.listPackagesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListPackages();

listPackagesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose packages will be listed.
pageSize number

The maximum number of packages to return. Maximum page size is 1,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Package on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listPackagesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPythonPackagesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose python packages will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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.
   */
  // 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 = await artifactregistryClient.listPythonPackagesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListPythonPackages();

listPythonPackagesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose python packages will be listed.
pageSize number

The maximum number of artifacts to return.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 listPythonPackagesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRepositoriesAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose repositories will be listed.
pageSize number

The maximum number of repositories to return. Maximum page size is 1,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Repository. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * 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'

  // 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 = await artifactregistryClient.listRepositoriesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRepositories();

listRepositoriesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the parent resource whose repositories will be listed.
pageSize number

The maximum number of repositories to return. Maximum page size is 1,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Repository on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRepositoriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTagsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.
filter string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `version`

An example of using a filter:

* `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"`
--> Tags that are applied to the version `1.0` in package `pkg1`.
pageSize number

The maximum number of tags to return. Maximum page size is 10,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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:
   *    * `version`
   *   An example of using a filter:
   *    * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"`
   *    --> Tags that are applied to the version `1.0` in package `pkg1`.
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of tags to return. Maximum page size is 10,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 = await artifactregistryClient.listTagsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTags();

listTagsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.
filter string

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

* `version`

An example of using a filter:

* `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"`
--> Tags that are applied to the version `1.0` in package `pkg1`.
pageSize number

The maximum number of tags to return. Maximum page size is 10,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Tag on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTagsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listVersionsAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The name of the parent resource whose versions will be listed.
pageSize number

The maximum number of versions to return. Maximum page size is 1,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
view google.devtools.artifactregistry.v1.VersionView

The view that should be returned in the response.
orderBy string <optional>

Optional. The field to order the results by.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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.
Example
  /**
   * 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'

  // 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 = await artifactregistryClient.listVersionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListVersions();

listVersionsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The name of the parent resource whose versions will be listed.
pageSize number

The maximum number of versions to return. Maximum page size is 1,000.
pageToken string

The next_page_token value returned from a previous list request, if any.
view google.devtools.artifactregistry.v1.VersionView

The view that should be returned in the response.
orderBy string <optional>

Optional. The field to order the results by.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Version on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAptArtifactFromAptArtifactName(aptArtifactName) → {string}

Parse the apt_artifact from AptArtifact resource.

Parameters:
Name Type Description
aptArtifactName string

A fully-qualified path representing AptArtifact resource.
Returns:
Type Description
string

A string representing the apt_artifact.

matchDockerImageFromDockerImageName(dockerImageName) → {string}

Parse the docker_image from DockerImage resource.

Parameters:
Name Type Description
dockerImageName string

A fully-qualified path representing DockerImage resource.
Returns:
Type Description
string

A string representing the docker_image.

matchFileFromFileName(fileName) → {string}

Parse the file from File resource.

Parameters:
Name Type Description
fileName string

A fully-qualified path representing File resource.
Returns:
Type Description
string

A string representing the file.

matchLocationFromAptArtifactName(aptArtifactName) → {string}

Parse the location from AptArtifact resource.

Parameters:
Name Type Description
aptArtifactName string

A fully-qualified path representing AptArtifact resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromDockerImageName(dockerImageName) → {string}

Parse the location from DockerImage resource.

Parameters:
Name Type Description
dockerImageName string

A fully-qualified path representing DockerImage resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromFileName(fileName) → {string}

Parse the location from File resource.

Parameters:
Name Type Description
fileName string

A fully-qualified path representing File resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromMavenArtifactName(mavenArtifactName) → {string}

Parse the location from MavenArtifact resource.

Parameters:
Name Type Description
mavenArtifactName string

A fully-qualified path representing MavenArtifact resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromNpmPackageName(npmPackageName) → {string}

Parse the location from NpmPackage resource.

Parameters:
Name Type Description
npmPackageName string

A fully-qualified path representing NpmPackage resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPackageName(packageName) → {string}

Parse the location from Package resource.

Parameters:
Name Type Description
packageName string

A fully-qualified path representing Package resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromPythonPackageName(pythonPackageName) → {string}

Parse the location from PythonPackage resource.

Parameters:
Name Type Description
pythonPackageName string

A fully-qualified path representing PythonPackage resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromRepositoryName(repositoryName) → {string}

Parse the location from Repository resource.

Parameters:
Name Type Description
repositoryName string

A fully-qualified path representing Repository resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromTagName(tagName) → {string}

Parse the location from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromVersionName(versionName) → {string}

Parse the location from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromVpcscConfigName(vpcscConfigName) → {string}

Parse the location from VpcscConfig resource.

Parameters:
Name Type Description
vpcscConfigName string

A fully-qualified path representing VpcscConfig resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromYumArtifactName(yumArtifactName) → {string}

Parse the location from YumArtifact resource.

Parameters:
Name Type Description
yumArtifactName string

A fully-qualified path representing YumArtifact resource.
Returns:
Type Description
string

A string representing the location.

matchMavenArtifactFromMavenArtifactName(mavenArtifactName) → {string}

Parse the maven_artifact from MavenArtifact resource.

Parameters:
Name Type Description
mavenArtifactName string

A fully-qualified path representing MavenArtifact resource.
Returns:
Type Description
string

A string representing the maven_artifact.

matchNpmPackageFromNpmPackageName(npmPackageName) → {string}

Parse the npm_package from NpmPackage resource.

Parameters:
Name Type Description
npmPackageName string

A fully-qualified path representing NpmPackage resource.
Returns:
Type Description
string

A string representing the npm_package.

matchPackageFromPackageName(packageName) → {string}

Parse the package from Package resource.

Parameters:
Name Type Description
packageName string

A fully-qualified path representing Package resource.
Returns:
Type Description
string

A string representing the package.

matchPackageFromTagName(tagName) → {string}

Parse the package from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the package.

matchPackageFromVersionName(versionName) → {string}

Parse the package from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the package.

matchProjectFromAptArtifactName(aptArtifactName) → {string}

Parse the project from AptArtifact resource.

Parameters:
Name Type Description
aptArtifactName string

A fully-qualified path representing AptArtifact resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromDockerImageName(dockerImageName) → {string}

Parse the project from DockerImage resource.

Parameters:
Name Type Description
dockerImageName string

A fully-qualified path representing DockerImage resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromFileName(fileName) → {string}

Parse the project from File resource.

Parameters:
Name Type Description
fileName string

A fully-qualified path representing File resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromMavenArtifactName(mavenArtifactName) → {string}

Parse the project from MavenArtifact resource.

Parameters:
Name Type Description
mavenArtifactName string

A fully-qualified path representing MavenArtifact resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromNpmPackageName(npmPackageName) → {string}

Parse the project from NpmPackage resource.

Parameters:
Name Type Description
npmPackageName string

A fully-qualified path representing NpmPackage resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPackageName(packageName) → {string}

Parse the project from Package resource.

Parameters:
Name Type Description
packageName string

A fully-qualified path representing Package resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectSettingsName(projectSettingsName) → {string}

Parse the project from ProjectSettings resource.

Parameters:
Name Type Description
projectSettingsName string

A fully-qualified path representing ProjectSettings resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromPythonPackageName(pythonPackageName) → {string}

Parse the project from PythonPackage resource.

Parameters:
Name Type Description
pythonPackageName string

A fully-qualified path representing PythonPackage resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromRepositoryName(repositoryName) → {string}

Parse the project from Repository resource.

Parameters:
Name Type Description
repositoryName string

A fully-qualified path representing Repository resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromTagName(tagName) → {string}

Parse the project from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromVersionName(versionName) → {string}

Parse the project from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromVpcscConfigName(vpcscConfigName) → {string}

Parse the project from VpcscConfig resource.

Parameters:
Name Type Description
vpcscConfigName string

A fully-qualified path representing VpcscConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromYumArtifactName(yumArtifactName) → {string}

Parse the project from YumArtifact resource.

Parameters:
Name Type Description
yumArtifactName string

A fully-qualified path representing YumArtifact resource.
Returns:
Type Description
string

A string representing the project.

matchPythonPackageFromPythonPackageName(pythonPackageName) → {string}

Parse the python_package from PythonPackage resource.

Parameters:
Name Type Description
pythonPackageName string

A fully-qualified path representing PythonPackage resource.
Returns:
Type Description
string

A string representing the python_package.

matchRepositoryFromAptArtifactName(aptArtifactName) → {string}

Parse the repository from AptArtifact resource.

Parameters:
Name Type Description
aptArtifactName string

A fully-qualified path representing AptArtifact resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromDockerImageName(dockerImageName) → {string}

Parse the repository from DockerImage resource.

Parameters:
Name Type Description
dockerImageName string

A fully-qualified path representing DockerImage resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromFileName(fileName) → {string}

Parse the repository from File resource.

Parameters:
Name Type Description
fileName string

A fully-qualified path representing File resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromMavenArtifactName(mavenArtifactName) → {string}

Parse the repository from MavenArtifact resource.

Parameters:
Name Type Description
mavenArtifactName string

A fully-qualified path representing MavenArtifact resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromNpmPackageName(npmPackageName) → {string}

Parse the repository from NpmPackage resource.

Parameters:
Name Type Description
npmPackageName string

A fully-qualified path representing NpmPackage resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromPackageName(packageName) → {string}

Parse the repository from Package resource.

Parameters:
Name Type Description
packageName string

A fully-qualified path representing Package resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromPythonPackageName(pythonPackageName) → {string}

Parse the repository from PythonPackage resource.

Parameters:
Name Type Description
pythonPackageName string

A fully-qualified path representing PythonPackage resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromRepositoryName(repositoryName) → {string}

Parse the repository from Repository resource.

Parameters:
Name Type Description
repositoryName string

A fully-qualified path representing Repository resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromTagName(tagName) → {string}

Parse the repository from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromVersionName(versionName) → {string}

Parse the repository from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the repository.

matchRepositoryFromYumArtifactName(yumArtifactName) → {string}

Parse the repository from YumArtifact resource.

Parameters:
Name Type Description
yumArtifactName string

A fully-qualified path representing YumArtifact resource.
Returns:
Type Description
string

A string representing the repository.

matchTagFromTagName(tagName) → {string}

Parse the tag from Tag resource.

Parameters:
Name Type Description
tagName string

A fully-qualified path representing Tag resource.
Returns:
Type Description
string

A string representing the tag.

matchVersionFromVersionName(versionName) → {string}

Parse the version from Version resource.

Parameters:
Name Type Description
versionName string

A fully-qualified path representing Version resource.
Returns:
Type Description
string

A string representing the version.

matchYumArtifactFromYumArtifactName(yumArtifactName) → {string}

Parse the yum_artifact from YumArtifact resource.

Parameters:
Name Type Description
yumArtifactName string

A fully-qualified path representing YumArtifact resource.
Returns:
Type Description
string

A string representing the yum_artifact.

mavenArtifactPath(project, location, repository, maven_artifact) → {string}

Return a fully-qualified mavenArtifact resource name string.

Parameters:
Name Type Description
project string
location string
repository string
maven_artifact string
Returns:
Type Description
string

Resource name string.

npmPackagePath(project, location, repository, npm_package) → {string}

Return a fully-qualified npmPackage resource name string.

Parameters:
Name Type Description
project string
location string
repository string
npm_package string
Returns:
Type Description
string

Resource name string.

packagePath(project, location, repository, packageParam) → {string}

Return a fully-qualified package resource name string.

Parameters:
Name Type Description
project string
location string
repository string
packageParam string
Returns:
Type Description
string

Resource name string.

projectSettingsPath(project) → {string}

Return a fully-qualified projectSettings resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

pythonPackagePath(project, location, repository, python_package) → {string}

Return a fully-qualified pythonPackage resource name string.

Parameters:
Name Type Description
project string
location string
repository string
python_package string
Returns:
Type Description
string

Resource name string.

repositoryPath(project, location, repository) → {string}

Return a fully-qualified repository resource name string.

Parameters:
Name Type Description
project string
location string
repository string
Returns:
Type Description
string

Resource name string.

tagPath(project, location, repository, packageParam, tag) → {string}

Return a fully-qualified tag resource name string.

Parameters:
Name Type Description
project string
location string
repository string
packageParam string
tag string
Returns:
Type Description
string

Resource name string.

versionPath(project, location, repository, packageParam, version) → {string}

Return a fully-qualified version resource name string.

Parameters:
Name Type Description
project string
location string
repository string
packageParam string
version string
Returns:
Type Description
string

Resource name string.

vpcscConfigPath(project, location) → {string}

Return a fully-qualified vpcscConfig resource name string.

Parameters:
Name Type Description
project string
location string
Returns:
Type Description
string

Resource name string.

yumArtifactPath(project, location, repository, yum_artifact) → {string}

Return a fully-qualified yumArtifact resource name string.

Parameters:
Name Type Description
project string
location string
repository string
yum_artifact string
Returns:
Type Description
string

Resource name string.