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)

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 fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

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

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.

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.

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.
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
  /**
   * 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'

  // 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.
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.

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.
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
  /**
   * 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.
   */
  // 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.
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.

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.

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.

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.

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.

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.

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.

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.

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.