Class v1.RegistryClient (1.0.1)

The Registry service allows teams to manage descriptions of APIs. v1

Package

@google-cloud/apigee-registry

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of RegistryClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: 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 RegistryClient({fallback: true}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

iamClient

iamClient: IamClient;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

registryStub

registryStub?: Promise<{
        [name: string]: Function;
    }>;

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.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

apiDeploymentPath(project, location, api, deployment)

apiDeploymentPath(project: string, location: string, api: string, deployment: string): string;

Return a fully-qualified apiDeployment resource name string.

Parameters
NameDescription
project string
location string
api string
deployment string
Returns
TypeDescription
string

{string} Resource name string.

apiPath(project, location, api)

apiPath(project: string, location: string, api: string): string;

Return a fully-qualified api resource name string.

Parameters
NameDescription
project string
location string
api string
Returns
TypeDescription
string

{string} Resource name string.

apiSpecPath(project, location, api, version, spec)

apiSpecPath(project: string, location: string, api: string, version: string, spec: string): string;

Return a fully-qualified apiSpec resource name string.

Parameters
NameDescription
project string
location string
api string
version string
spec string
Returns
TypeDescription
string

{string} Resource name string.

apiVersionPath(project, location, api, version)

apiVersionPath(project: string, location: string, api: string, version: string): string;

Return a fully-qualified apiVersion resource name string.

Parameters
NameDescription
project string
location string
api string
version string
Returns
TypeDescription
string

{string} Resource name string.

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createApi(request, options)

createApi(request?: protos.google.cloud.apigeeregistry.v1.ICreateApiRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApi,
        protos.google.cloud.apigeeregistry.v1.ICreateApiRequest | undefined,
        {} | undefined
    ]>;

Creates a specified API.

Parameters
NameDescription
request ICreateApiRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.ICreateApiRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Api. 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 parent, which owns this collection of APIs.
   *  Format: `projects/* /locations/*`
   */
  // const parent = 'abc123'
  /**
   *  Required. The API to create.
   */
  // const api = {}
  /**
   *  Required. The ID to use for the API, which will become the final component of
   *  the API's resource name.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][0-9]-/.
   *  Following AIP-162, IDs must not have the form of a UUID.
   */
  // const apiId = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callCreateApi() {
    // Construct request
    const request = {
      parent,
      api,
      apiId,
    };

    // Run request
    const response = await apigeeregistryClient.createApi(request);
    console.log(response);
  }

  callCreateApi();

createApi(request, options, callback)

createApi(request: protos.google.cloud.apigeeregistry.v1.ICreateApiRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.ICreateApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.ICreateApiRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApi(request, callback)

createApi(request: protos.google.cloud.apigeeregistry.v1.ICreateApiRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.ICreateApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.ICreateApiRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApiDeployment(request, options)

createApiDeployment(request?: protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiDeployment,
        (protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest | undefined),
        {} | undefined
    ]>;

Creates a specified deployment.

Parameters
NameDescription
request ICreateApiDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiDeployment, (protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiDeployment. 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 parent, which owns this collection of deployments.
   *  Format: `projects/* /locations/* /apis/*`
   */
  // const parent = 'abc123'
  /**
   *  Required. The deployment to create.
   */
  // const apiDeployment = {}
  /**
   *  Required. The ID to use for the deployment, which will become the final component of
   *  the deployment's resource name.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][0-9]-/.
   *  Following AIP-162, IDs must not have the form of a UUID.
   */
  // const apiDeploymentId = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callCreateApiDeployment() {
    // Construct request
    const request = {
      parent,
      apiDeployment,
      apiDeploymentId,
    };

    // Run request
    const response = await apigeeregistryClient.createApiDeployment(request);
    console.log(response);
  }

  callCreateApiDeployment();

createApiDeployment(request, options, callback)

createApiDeployment(request: protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApiDeployment(request, callback)

createApiDeployment(request: protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiDeploymentRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.ICreateApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApiSpec(request, options)

createApiSpec(request?: protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiSpec,
        protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest | undefined,
        {} | undefined
    ]>;

Creates a specified spec.

Parameters
NameDescription
request ICreateApiSpecRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiSpec. 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 parent, which owns this collection of specs.
   *  Format: `projects/* /locations/* /apis/* /versions/*`
   */
  // const parent = 'abc123'
  /**
   *  Required. The spec to create.
   */
  // const apiSpec = {}
  /**
   *  Required. The ID to use for the spec, which will become the final component of
   *  the spec's resource name.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][0-9]-/.
   *  Following AIP-162, IDs must not have the form of a UUID.
   */
  // const apiSpecId = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callCreateApiSpec() {
    // Construct request
    const request = {
      parent,
      apiSpec,
      apiSpecId,
    };

    // Run request
    const response = await apigeeregistryClient.createApiSpec(request);
    console.log(response);
  }

  callCreateApiSpec();

createApiSpec(request, options, callback)

createApiSpec(request: protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiSpecRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApiSpec(request, callback)

createApiSpec(request: protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiSpecRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.ICreateApiSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApiVersion(request, options)

createApiVersion(request?: protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiVersion,
        (protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest | undefined),
        {} | undefined
    ]>;

Creates a specified version.

Parameters
NameDescription
request ICreateApiVersionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiVersion, (protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiVersion. 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 parent, which owns this collection of versions.
   *  Format: `projects/* /locations/* /apis/*`
   */
  // const parent = 'abc123'
  /**
   *  Required. The version to create.
   */
  // const apiVersion = {}
  /**
   *  Required. The ID to use for the version, which will become the final component of
   *  the version's resource name.
   *  This value should be 1-63 characters, and valid characters
   *  are /[a-z][0-9]-/.
   *  Following AIP-162, IDs must not have the form of a UUID.
   */
  // const apiVersionId = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callCreateApiVersion() {
    // Construct request
    const request = {
      parent,
      apiVersion,
      apiVersionId,
    };

    // Run request
    const response = await apigeeregistryClient.createApiVersion(request);
    console.log(response);
  }

  callCreateApiVersion();

createApiVersion(request, options, callback)

createApiVersion(request: protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiVersionRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createApiVersion(request, callback)

createApiVersion(request: protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateApiVersionRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.ICreateApiVersionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createArtifact(request, options)

createArtifact(request?: protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IArtifact,
        protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest | undefined,
        {} | undefined
    ]>;

Creates a specified artifact.

Parameters
NameDescription
request ICreateArtifactRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Artifact. 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 parent, which owns this collection of artifacts.
   *  Format: `{parent}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The artifact to create.
   */
  // const artifact = {}
  /**
   *  Required. The ID to use for the artifact, which will become the final component of
   *  the artifact's resource name.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][0-9]-/.
   *  Following AIP-162, IDs must not have the form of a UUID.
   */
  // const artifactId = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callCreateArtifact() {
    // Construct request
    const request = {
      parent,
      artifact,
      artifactId,
    };

    // Run request
    const response = await apigeeregistryClient.createArtifact(request);
    console.log(response);
  }

  callCreateArtifact();

createArtifact(request, options, callback)

createArtifact(request: protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateArtifactRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createArtifact(request, callback)

createArtifact(request: protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateArtifactRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.ICreateArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApi(request, options)

deleteApi(request?: protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest | undefined,
        {} | undefined
    ]>;

Removes a specified API and all of the resources that it owns.

Parameters
NameDescription
request IDeleteApiRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest | 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.

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 API to delete.
   *  Format: `projects/* /locations/* /apis/*`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any child resources will also be deleted.
   *  (Otherwise, the request will only work if there are no child resources.)
   */
  // const force = true

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteApi() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteApi(request);
    console.log(response);
  }

  callDeleteApi();

deleteApi(request, options, callback)

deleteApi(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApi(request, callback)

deleteApi(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiDeployment(request, options)

deleteApiDeployment(request?: protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest | undefined),
        {} | undefined
    ]>;

Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).

Parameters
NameDescription
request IDeleteApiDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest | 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.

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 deployment to delete.
   *  Format: `projects/* /locations/* /apis/* /deployments/*`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any child resources will also be deleted.
   *  (Otherwise, the request will only work if there are no child resources.)
   */
  // const force = true

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteApiDeployment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteApiDeployment(request);
    console.log(response);
  }

  callDeleteApiDeployment();

deleteApiDeployment(request, options, callback)

deleteApiDeployment(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiDeploymentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiDeployment(request, callback)

deleteApiDeployment(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiDeploymentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiDeploymentRevision(request, options)

deleteApiDeploymentRevision(request?: protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiDeployment,
        (protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest | undefined),
        {} | undefined
    ]>;

Deletes a revision of a deployment.

Parameters
NameDescription
request IDeleteApiDeploymentRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiDeployment, (protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiDeployment. 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 deployment revision to be deleted,
   *  with a revision ID explicitly included.
   *  Example:
   *  `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteApiDeploymentRevision() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteApiDeploymentRevision(request);
    console.log(response);
  }

  callDeleteApiDeploymentRevision();

deleteApiDeploymentRevision(request, options, callback)

deleteApiDeploymentRevision(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiDeploymentRevisionRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiDeploymentRevision(request, callback)

deleteApiDeploymentRevision(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiDeploymentRevisionRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IDeleteApiDeploymentRevisionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiSpec(request, options)

deleteApiSpec(request?: protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest | undefined,
        {} | undefined
    ]>;

Removes a specified spec, all revisions, and all child resources (e.g., artifacts).

Parameters
NameDescription
request IDeleteApiSpecRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest | 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.

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 spec to delete.
   *  Format: `projects/* /locations/* /apis/* /versions/* /specs/*`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any child resources will also be deleted.
   *  (Otherwise, the request will only work if there are no child resources.)
   */
  // const force = true

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteApiSpec() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteApiSpec(request);
    console.log(response);
  }

  callDeleteApiSpec();

deleteApiSpec(request, options, callback)

deleteApiSpec(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiSpecRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiSpec(request, callback)

deleteApiSpec(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiSpecRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiSpecRevision(request, options)

deleteApiSpecRevision(request?: protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiSpec,
        (protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest | undefined),
        {} | undefined
    ]>;

Deletes a revision of a spec.

Parameters
NameDescription
request IDeleteApiSpecRevisionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiSpec, (protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiSpec. 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 spec revision to be deleted,
   *  with a revision ID explicitly included.
   *  Example:
   *  `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteApiSpecRevision() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteApiSpecRevision(request);
    console.log(response);
  }

  callDeleteApiSpecRevision();

deleteApiSpecRevision(request, options, callback)

deleteApiSpecRevision(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiSpecRevisionRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiSpecRevision(request, callback)

deleteApiSpecRevision(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiSpecRevisionRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IDeleteApiSpecRevisionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiVersion(request, options)

deleteApiVersion(request?: protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest | undefined),
        {} | undefined
    ]>;

Removes a specified version and all of the resources that it owns.

Parameters
NameDescription
request IDeleteApiVersionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest | 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.

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 version to delete.
   *  Format: `projects/* /locations/* /apis/* /versions/*`
   */
  // const name = 'abc123'
  /**
   *  If set to true, any child resources will also be deleted.
   *  (Otherwise, the request will only work if there are no child resources.)
   */
  // const force = true

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteApiVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteApiVersion(request);
    console.log(response);
  }

  callDeleteApiVersion();

deleteApiVersion(request, options, callback)

deleteApiVersion(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiVersionRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteApiVersion(request, callback)

deleteApiVersion(request: protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteApiVersionRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteApiVersionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteArtifact(request, options)

deleteArtifact(request?: protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest | undefined,
        {} | undefined
    ]>;

Removes a specified artifact.

Parameters
NameDescription
request IDeleteArtifactRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest | 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.

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 artifact to delete.
   *  Format: `{parent}/artifacts/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callDeleteArtifact() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.deleteArtifact(request);
    console.log(response);
  }

  callDeleteArtifact();

deleteArtifact(request, options, callback)

deleteArtifact(request: protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteArtifactRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteArtifact(request, callback)

deleteArtifact(request: protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteArtifactRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.apigeeregistry.v1.IDeleteArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApi(request, options)

getApi(request?: protos.google.cloud.apigeeregistry.v1.IGetApiRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApi,
        protos.google.cloud.apigeeregistry.v1.IGetApiRequest | undefined,
        {} | undefined
    ]>;

Returns a specified API.

Parameters
NameDescription
request IGetApiRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.IGetApiRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Api. 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 API to retrieve.
   *  Format: `projects/* /locations/* /apis/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetApi() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getApi(request);
    console.log(response);
  }

  callGetApi();

getApi(request, options, callback)

getApi(request: protos.google.cloud.apigeeregistry.v1.IGetApiRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.IGetApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.IGetApiRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApi(request, callback)

getApi(request: protos.google.cloud.apigeeregistry.v1.IGetApiRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.IGetApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApi, protos.google.cloud.apigeeregistry.v1.IGetApiRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiDeployment(request, options)

getApiDeployment(request?: protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiDeployment,
        (protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest | undefined),
        {} | undefined
    ]>;

Returns a specified deployment.

Parameters
NameDescription
request IGetApiDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiDeployment, (protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiDeployment. 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 deployment to retrieve.
   *  Format: `projects/* /locations/* /apis/* /deployments/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetApiDeployment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getApiDeployment(request);
    console.log(response);
  }

  callGetApiDeployment();

getApiDeployment(request, options, callback)

getApiDeployment(request: protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiDeployment(request, callback)

getApiDeployment(request: protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiDeploymentRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IGetApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiSpec(request, options)

getApiSpec(request?: protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiSpec,
        protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest | undefined,
        {} | undefined
    ]>;

Returns a specified spec.

Parameters
NameDescription
request IGetApiSpecRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiSpec. 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 spec to retrieve.
   *  Format: `projects/* /locations/* /apis/* /versions/* /specs/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetApiSpec() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getApiSpec(request);
    console.log(response);
  }

  callGetApiSpec();

getApiSpec(request, options, callback)

getApiSpec(request: protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiSpecRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiSpec(request, callback)

getApiSpec(request: protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiSpecRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IGetApiSpecRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiSpecContents(request, options)

getApiSpecContents(request?: protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest, options?: CallOptions): Promise<[
        protos.google.api.IHttpBody,
        (protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest | undefined),
        {} | undefined
    ]>;

Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).

Parameters
NameDescription
request IGetApiSpecContentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.api.IHttpBody, (protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing HttpBody. 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 spec whose contents should be retrieved.
   *  Format: `projects/* /locations/* /apis/* /versions/* /specs/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetApiSpecContents() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getApiSpecContents(request);
    console.log(response);
  }

  callGetApiSpecContents();

getApiSpecContents(request, options, callback)

getApiSpecContents(request: protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiSpecContentsRequest
options CallOptions
callback Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiSpecContents(request, callback)

getApiSpecContents(request: protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiSpecContentsRequest
callback Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetApiSpecContentsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiVersion(request, options)

getApiVersion(request?: protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiVersion,
        protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest | undefined,
        {} | undefined
    ]>;

Returns a specified version.

Parameters
NameDescription
request IGetApiVersionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiVersion. 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 version to retrieve.
   *  Format: `projects/* /locations/* /apis/* /versions/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetApiVersion() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getApiVersion(request);
    console.log(response);
  }

  callGetApiVersion();

getApiVersion(request, options, callback)

getApiVersion(request: protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiVersionRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getApiVersion(request, callback)

getApiVersion(request: protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetApiVersionRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiVersion, protos.google.cloud.apigeeregistry.v1.IGetApiVersionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getArtifact(request, options)

getArtifact(request?: protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IArtifact,
        protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest | undefined,
        {} | undefined
    ]>;

Returns a specified artifact.

Parameters
NameDescription
request IGetArtifactRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Artifact. 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 artifact to retrieve.
   *  Format: `{parent}/artifacts/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetArtifact() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getArtifact(request);
    console.log(response);
  }

  callGetArtifact();

getArtifact(request, options, callback)

getArtifact(request: protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetArtifactRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getArtifact(request, callback)

getArtifact(request: protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetArtifactRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IGetArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getArtifactContents(request, options)

getArtifactContents(request?: protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest, options?: CallOptions): Promise<[
        protos.google.api.IHttpBody,
        (protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest | undefined),
        {} | undefined
    ]>;

Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).

Parameters
NameDescription
request IGetArtifactContentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.api.IHttpBody, (protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing HttpBody. 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 artifact whose contents should be retrieved.
   *  Format: `{parent}/artifacts/*`
   */
  // const name = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callGetArtifactContents() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await apigeeregistryClient.getArtifactContents(request);
    console.log(response);
  }

  callGetArtifactContents();

getArtifactContents(request, options, callback)

getArtifactContents(request: protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetArtifactContentsRequest
options CallOptions
callback Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getArtifactContents(request, callback)

getArtifactContents(request: protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetArtifactContentsRequest
callback Callback<protos.google.api.IHttpBody, protos.google.cloud.apigeeregistry.v1.IGetArtifactContentsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
NameDescription
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

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

callback Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | 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 .

Returns
TypeDescription
Promise<[google.iam.v1.Policy]>

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

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
NameDescription
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
TypeDescription
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.

Example

const [response] = await client.getLocation(request);

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instancePath(project, location, instance)

instancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters
NameDescription
project string
location string
instance string
Returns
TypeDescription
string

{string} Resource name string.

listApiDeploymentRevisions(request, options)

listApiDeploymentRevisions(request?: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiDeployment[],
        protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsResponse
    ]>;

Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.

Parameters
NameDescription
request IListApiDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiDeployment[], protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest | null, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ApiDeployment. 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 listApiDeploymentRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiDeploymentRevisions(request, options, callback)

listApiDeploymentRevisions(request: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>): void;
Parameters
NameDescription
request IListApiDeploymentRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>
Returns
TypeDescription
void

listApiDeploymentRevisions(request, callback)

listApiDeploymentRevisions(request: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>): void;
Parameters
NameDescription
request IListApiDeploymentRevisionsRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>
Returns
TypeDescription
void

listApiDeploymentRevisionsAsync(request, options)

listApiDeploymentRevisionsAsync(request?: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiDeployment>;

Equivalent to listApiDeploymentRevisions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListApiDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiDeployment>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ApiDeployment. 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 deployment to list revisions for.
   */
  // const name = 'abc123'
  /**
   *  The maximum number of revisions to return per page.
   */
  // const pageSize = 1234
  /**
   *  The page token, received from a previous ListApiDeploymentRevisions call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListApiDeploymentRevisions() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = await apigeeregistryClient.listApiDeploymentRevisionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListApiDeploymentRevisions();

listApiDeploymentRevisionsStream(request, options)

listApiDeploymentRevisionsStream(request?: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListApiDeploymentRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ApiDeployment 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 listApiDeploymentRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiDeployments(request, options)

listApiDeployments(request?: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiDeployment[],
        protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsResponse
    ]>;

Returns matching deployments.

Parameters
NameDescription
request IListApiDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiDeployment[], protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest | null, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ApiDeployment. 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 listApiDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiDeployments(request, options, callback)

listApiDeployments(request: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>): void;
Parameters
NameDescription
request IListApiDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>
Returns
TypeDescription
void

listApiDeployments(request, callback)

listApiDeployments(request: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>): void;
Parameters
NameDescription
request IListApiDeploymentsRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiDeployment>
Returns
TypeDescription
void

listApiDeploymentsAsync(request, options)

listApiDeploymentsAsync(request?: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiDeployment>;

Equivalent to listApiDeployments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListApiDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiDeployment>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ApiDeployment. 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 parent, which owns this collection of deployments.
   *  Format: `projects/* /locations/* /apis/*`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of deployments to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 50 values will be returned.
   *  The maximum is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListApiDeployments` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListApiDeployments` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that can be used to filter the list. Filters use the Common
   *  Expression Language and can refer to all message fields.
   */
  // const filter = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListApiDeployments() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await apigeeregistryClient.listApiDeploymentsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListApiDeployments();

listApiDeploymentsStream(request, options)

listApiDeploymentsStream(request?: protos.google.cloud.apigeeregistry.v1.IListApiDeploymentsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListApiDeploymentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ApiDeployment 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 listApiDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApis(request, options)

listApis(request?: protos.google.cloud.apigeeregistry.v1.IListApisRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApi[],
        protos.google.cloud.apigeeregistry.v1.IListApisRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListApisResponse
    ]>;

Returns matching APIs.

Parameters
NameDescription
request IListApisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApi[], protos.google.cloud.apigeeregistry.v1.IListApisRequest | null, protos.google.cloud.apigeeregistry.v1.IListApisResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Api. 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 listApisAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApis(request, options, callback)

listApis(request: protos.google.cloud.apigeeregistry.v1.IListApisRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApisRequest, protos.google.cloud.apigeeregistry.v1.IListApisResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApi>): void;
Parameters
NameDescription
request IListApisRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApisRequest, protos.google.cloud.apigeeregistry.v1.IListApisResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApi>
Returns
TypeDescription
void

listApis(request, callback)

listApis(request: protos.google.cloud.apigeeregistry.v1.IListApisRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApisRequest, protos.google.cloud.apigeeregistry.v1.IListApisResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApi>): void;
Parameters
NameDescription
request IListApisRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApisRequest, protos.google.cloud.apigeeregistry.v1.IListApisResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApi>
Returns
TypeDescription
void

listApisAsync(request, options)

listApisAsync(request?: protos.google.cloud.apigeeregistry.v1.IListApisRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApi>;

Equivalent to listApis, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListApisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApi>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Api. 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 parent, which owns this collection of APIs.
   *  Format: projects/* /locations/*
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of APIs to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 50 values will be returned.
   *  The maximum is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListApis` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListApis` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that can be used to filter the list. Filters use the Common
   *  Expression Language and can refer to all message fields.
   */
  // const filter = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListApis() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await apigeeregistryClient.listApisAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListApis();

listApiSpecRevisions(request, options)

listApiSpecRevisions(request?: protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiSpec[],
        protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsResponse
    ]>;

Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.

Parameters
NameDescription
request IListApiSpecRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiSpec[], protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest | null, protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ApiSpec. 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 listApiSpecRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiSpecRevisions(request, options, callback)

listApiSpecRevisions(request: protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>): void;
Parameters
NameDescription
request IListApiSpecRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>
Returns
TypeDescription
void

listApiSpecRevisions(request, callback)

listApiSpecRevisions(request: protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>): void;
Parameters
NameDescription
request IListApiSpecRevisionsRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>
Returns
TypeDescription
void

listApiSpecRevisionsAsync(request, options)

listApiSpecRevisionsAsync(request?: protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiSpec>;

Equivalent to listApiSpecRevisions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListApiSpecRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiSpec>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ApiSpec. 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 spec to list revisions for.
   */
  // const name = 'abc123'
  /**
   *  The maximum number of revisions to return per page.
   */
  // const pageSize = 1234
  /**
   *  The page token, received from a previous ListApiSpecRevisions call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListApiSpecRevisions() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = await apigeeregistryClient.listApiSpecRevisionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListApiSpecRevisions();

listApiSpecRevisionsStream(request, options)

listApiSpecRevisionsStream(request?: protos.google.cloud.apigeeregistry.v1.IListApiSpecRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListApiSpecRevisionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ApiSpec 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 listApiSpecRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiSpecs(request, options)

listApiSpecs(request?: protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiSpec[],
        protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListApiSpecsResponse
    ]>;

Returns matching specs.

Parameters
NameDescription
request IListApiSpecsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiSpec[], protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest | null, protos.google.cloud.apigeeregistry.v1.IListApiSpecsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ApiSpec. 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 listApiSpecsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiSpecs(request, options, callback)

listApiSpecs(request: protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>): void;
Parameters
NameDescription
request IListApiSpecsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>
Returns
TypeDescription
void

listApiSpecs(request, callback)

listApiSpecs(request: protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>): void;
Parameters
NameDescription
request IListApiSpecsRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, protos.google.cloud.apigeeregistry.v1.IListApiSpecsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiSpec>
Returns
TypeDescription
void

listApiSpecsAsync(request, options)

listApiSpecsAsync(request?: protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiSpec>;

Equivalent to listApiSpecs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListApiSpecsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiSpec>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ApiSpec. 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 parent, which owns this collection of specs.
   *  Format: `projects/* /locations/* /apis/* /versions/*`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of specs to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 50 values will be returned.
   *  The maximum is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListApiSpecs` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListApiSpecs` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that can be used to filter the list. Filters use the Common
   *  Expression Language and can refer to all message fields except contents.
   */
  // const filter = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListApiSpecs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await apigeeregistryClient.listApiSpecsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListApiSpecs();

listApiSpecsStream(request, options)

listApiSpecsStream(request?: protos.google.cloud.apigeeregistry.v1.IListApiSpecsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListApiSpecsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ApiSpec 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 listApiSpecsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApisStream(request, options)

listApisStream(request?: protos.google.cloud.apigeeregistry.v1.IListApisRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListApisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing Api 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 listApisAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiVersions(request, options)

listApiVersions(request?: protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiVersion[],
        protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListApiVersionsResponse
    ]>;

Returns matching versions.

Parameters
NameDescription
request IListApiVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiVersion[], protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest | null, protos.google.cloud.apigeeregistry.v1.IListApiVersionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ApiVersion. 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 listApiVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listApiVersions(request, options, callback)

listApiVersions(request: protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiVersionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiVersion>): void;
Parameters
NameDescription
request IListApiVersionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiVersionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiVersion>
Returns
TypeDescription
void

listApiVersions(request, callback)

listApiVersions(request: protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiVersionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiVersion>): void;
Parameters
NameDescription
request IListApiVersionsRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, protos.google.cloud.apigeeregistry.v1.IListApiVersionsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IApiVersion>
Returns
TypeDescription
void

listApiVersionsAsync(request, options)

listApiVersionsAsync(request?: protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiVersion>;

Equivalent to listApiVersions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListApiVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IApiVersion>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ApiVersion. 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 parent, which owns this collection of versions.
   *  Format: `projects/* /locations/* /apis/*`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of versions to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 50 values will be returned.
   *  The maximum is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListApiVersions` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListApiVersions` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that can be used to filter the list. Filters use the Common
   *  Expression Language and can refer to all message fields.
   */
  // const filter = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListApiVersions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await apigeeregistryClient.listApiVersionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListApiVersions();

listApiVersionsStream(request, options)

listApiVersionsStream(request?: protos.google.cloud.apigeeregistry.v1.IListApiVersionsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListApiVersionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing ApiVersion 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 listApiVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listArtifacts(request, options)

listArtifacts(request?: protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IArtifact[],
        protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest | null,
        protos.google.cloud.apigeeregistry.v1.IListArtifactsResponse
    ]>;

Returns matching artifacts.

Parameters
NameDescription
request IListArtifactsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IArtifact[], protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest | null, protos.google.cloud.apigeeregistry.v1.IListArtifactsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Artifact. 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 listArtifactsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listArtifacts(request, options, callback)

listArtifacts(request: protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, protos.google.cloud.apigeeregistry.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IArtifact>): void;
Parameters
NameDescription
request IListArtifactsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, protos.google.cloud.apigeeregistry.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IArtifact>
Returns
TypeDescription
void

listArtifacts(request, callback)

listArtifacts(request: protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, callback: PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, protos.google.cloud.apigeeregistry.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IArtifact>): void;
Parameters
NameDescription
request IListArtifactsRequest
callback PaginationCallback<protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, protos.google.cloud.apigeeregistry.v1.IListArtifactsResponse | null | undefined, protos.google.cloud.apigeeregistry.v1.IArtifact>
Returns
TypeDescription
void

listArtifactsAsync(request, options)

listArtifactsAsync(request?: protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigeeregistry.v1.IArtifact>;

Equivalent to listArtifacts, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListArtifactsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.apigeeregistry.v1.IArtifact>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Artifact. 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 parent, which owns this collection of artifacts.
   *  Format: `{parent}`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of artifacts to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 50 values will be returned.
   *  The maximum is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListArtifacts` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListArtifacts` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  An expression that can be used to filter the list. Filters use the Common
   *  Expression Language and can refer to all message fields except contents.
   */
  // const filter = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callListArtifacts() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await apigeeregistryClient.listArtifactsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListArtifacts();

listArtifactsStream(request, options)

listArtifactsStream(request?: protos.google.cloud.apigeeregistry.v1.IListArtifactsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListArtifactsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing Artifact 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 listArtifactsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchApiFromApiDeploymentName(apiDeploymentName)

matchApiFromApiDeploymentName(apiDeploymentName: string): string | number;

Parse the api from ApiDeployment resource.

Parameter
NameDescription
apiDeploymentName string

A fully-qualified path representing ApiDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromApiName(apiName)

matchApiFromApiName(apiName: string): string | number;

Parse the api from Api resource.

Parameter
NameDescription
apiName string

A fully-qualified path representing Api resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromApiSpecName(apiSpecName)

matchApiFromApiSpecName(apiSpecName: string): string | number;

Parse the api from ApiSpec resource.

Parameter
NameDescription
apiSpecName string

A fully-qualified path representing ApiSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromApiVersionName(apiVersionName)

matchApiFromApiVersionName(apiVersionName: string): string | number;

Parse the api from ApiVersion resource.

Parameter
NameDescription
apiVersionName string

A fully-qualified path representing ApiVersion resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromProjectLocationApiArtifactName(projectLocationApiArtifactName)

matchApiFromProjectLocationApiArtifactName(projectLocationApiArtifactName: string): string | number;

Parse the api from ProjectLocationApiArtifact resource.

Parameter
NameDescription
projectLocationApiArtifactName string

A fully-qualified path representing project_location_api_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName)

matchApiFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName: string): string | number;

Parse the api from ProjectLocationApiDeploymentArtifact resource.

Parameter
NameDescription
projectLocationApiDeploymentArtifactName string

A fully-qualified path representing project_location_api_deployment_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName)

matchApiFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName: string): string | number;

Parse the api from ProjectLocationApiVersionArtifact resource.

Parameter
NameDescription
projectLocationApiVersionArtifactName string

A fully-qualified path representing project_location_api_version_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchApiFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName)

matchApiFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName: string): string | number;

Parse the api from ProjectLocationApiVersionSpecArtifact resource.

Parameter
NameDescription
projectLocationApiVersionSpecArtifactName string

A fully-qualified path representing project_location_api_version_spec_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the api.

matchArtifactFromProjectLocationApiArtifactName(projectLocationApiArtifactName)

matchArtifactFromProjectLocationApiArtifactName(projectLocationApiArtifactName: string): string | number;

Parse the artifact from ProjectLocationApiArtifact resource.

Parameter
NameDescription
projectLocationApiArtifactName string

A fully-qualified path representing project_location_api_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchArtifactFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName)

matchArtifactFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName: string): string | number;

Parse the artifact from ProjectLocationApiDeploymentArtifact resource.

Parameter
NameDescription
projectLocationApiDeploymentArtifactName string

A fully-qualified path representing project_location_api_deployment_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchArtifactFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName)

matchArtifactFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName: string): string | number;

Parse the artifact from ProjectLocationApiVersionArtifact resource.

Parameter
NameDescription
projectLocationApiVersionArtifactName string

A fully-qualified path representing project_location_api_version_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchArtifactFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName)

matchArtifactFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName: string): string | number;

Parse the artifact from ProjectLocationApiVersionSpecArtifact resource.

Parameter
NameDescription
projectLocationApiVersionSpecArtifactName string

A fully-qualified path representing project_location_api_version_spec_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchArtifactFromProjectLocationArtifactName(projectLocationArtifactName)

matchArtifactFromProjectLocationArtifactName(projectLocationArtifactName: string): string | number;

Parse the artifact from ProjectLocationArtifact resource.

Parameter
NameDescription
projectLocationArtifactName string

A fully-qualified path representing project_location_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the artifact.

matchDeploymentFromApiDeploymentName(apiDeploymentName)

matchDeploymentFromApiDeploymentName(apiDeploymentName: string): string | number;

Parse the deployment from ApiDeployment resource.

Parameter
NameDescription
apiDeploymentName string

A fully-qualified path representing ApiDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchDeploymentFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName)

matchDeploymentFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName: string): string | number;

Parse the deployment from ProjectLocationApiDeploymentArtifact resource.

Parameter
NameDescription
projectLocationApiDeploymentArtifactName string

A fully-qualified path representing project_location_api_deployment_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the instance.

matchLocationFromApiDeploymentName(apiDeploymentName)

matchLocationFromApiDeploymentName(apiDeploymentName: string): string | number;

Parse the location from ApiDeployment resource.

Parameter
NameDescription
apiDeploymentName string

A fully-qualified path representing ApiDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromApiName(apiName)

matchLocationFromApiName(apiName: string): string | number;

Parse the location from Api resource.

Parameter
NameDescription
apiName string

A fully-qualified path representing Api resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromApiSpecName(apiSpecName)

matchLocationFromApiSpecName(apiSpecName: string): string | number;

Parse the location from ApiSpec resource.

Parameter
NameDescription
apiSpecName string

A fully-qualified path representing ApiSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromApiVersionName(apiVersionName)

matchLocationFromApiVersionName(apiVersionName: string): string | number;

Parse the location from ApiVersion resource.

Parameter
NameDescription
apiVersionName string

A fully-qualified path representing ApiVersion resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationApiArtifactName(projectLocationApiArtifactName)

matchLocationFromProjectLocationApiArtifactName(projectLocationApiArtifactName: string): string | number;

Parse the location from ProjectLocationApiArtifact resource.

Parameter
NameDescription
projectLocationApiArtifactName string

A fully-qualified path representing project_location_api_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName)

matchLocationFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName: string): string | number;

Parse the location from ProjectLocationApiDeploymentArtifact resource.

Parameter
NameDescription
projectLocationApiDeploymentArtifactName string

A fully-qualified path representing project_location_api_deployment_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName)

matchLocationFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName: string): string | number;

Parse the location from ProjectLocationApiVersionArtifact resource.

Parameter
NameDescription
projectLocationApiVersionArtifactName string

A fully-qualified path representing project_location_api_version_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName)

matchLocationFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName: string): string | number;

Parse the location from ProjectLocationApiVersionSpecArtifact resource.

Parameter
NameDescription
projectLocationApiVersionSpecArtifactName string

A fully-qualified path representing project_location_api_version_spec_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationArtifactName(projectLocationArtifactName)

matchLocationFromProjectLocationArtifactName(projectLocationArtifactName: string): string | number;

Parse the location from ProjectLocationArtifact resource.

Parameter
NameDescription
projectLocationArtifactName string

A fully-qualified path representing project_location_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromApiDeploymentName(apiDeploymentName)

matchProjectFromApiDeploymentName(apiDeploymentName: string): string | number;

Parse the project from ApiDeployment resource.

Parameter
NameDescription
apiDeploymentName string

A fully-qualified path representing ApiDeployment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromApiName(apiName)

matchProjectFromApiName(apiName: string): string | number;

Parse the project from Api resource.

Parameter
NameDescription
apiName string

A fully-qualified path representing Api resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromApiSpecName(apiSpecName)

matchProjectFromApiSpecName(apiSpecName: string): string | number;

Parse the project from ApiSpec resource.

Parameter
NameDescription
apiSpecName string

A fully-qualified path representing ApiSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromApiVersionName(apiVersionName)

matchProjectFromApiVersionName(apiVersionName: string): string | number;

Parse the project from ApiVersion resource.

Parameter
NameDescription
apiVersionName string

A fully-qualified path representing ApiVersion resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
NameDescription
instanceName string

A fully-qualified path representing Instance resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationApiArtifactName(projectLocationApiArtifactName)

matchProjectFromProjectLocationApiArtifactName(projectLocationApiArtifactName: string): string | number;

Parse the project from ProjectLocationApiArtifact resource.

Parameter
NameDescription
projectLocationApiArtifactName string

A fully-qualified path representing project_location_api_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName)

matchProjectFromProjectLocationApiDeploymentArtifactName(projectLocationApiDeploymentArtifactName: string): string | number;

Parse the project from ProjectLocationApiDeploymentArtifact resource.

Parameter
NameDescription
projectLocationApiDeploymentArtifactName string

A fully-qualified path representing project_location_api_deployment_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName)

matchProjectFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName: string): string | number;

Parse the project from ProjectLocationApiVersionArtifact resource.

Parameter
NameDescription
projectLocationApiVersionArtifactName string

A fully-qualified path representing project_location_api_version_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName)

matchProjectFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName: string): string | number;

Parse the project from ProjectLocationApiVersionSpecArtifact resource.

Parameter
NameDescription
projectLocationApiVersionSpecArtifactName string

A fully-qualified path representing project_location_api_version_spec_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationArtifactName(projectLocationArtifactName)

matchProjectFromProjectLocationArtifactName(projectLocationArtifactName: string): string | number;

Parse the project from ProjectLocationArtifact resource.

Parameter
NameDescription
projectLocationArtifactName string

A fully-qualified path representing project_location_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchSpecFromApiSpecName(apiSpecName)

matchSpecFromApiSpecName(apiSpecName: string): string | number;

Parse the spec from ApiSpec resource.

Parameter
NameDescription
apiSpecName string

A fully-qualified path representing ApiSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the spec.

matchSpecFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName)

matchSpecFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName: string): string | number;

Parse the spec from ProjectLocationApiVersionSpecArtifact resource.

Parameter
NameDescription
projectLocationApiVersionSpecArtifactName string

A fully-qualified path representing project_location_api_version_spec_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the spec.

matchVersionFromApiSpecName(apiSpecName)

matchVersionFromApiSpecName(apiSpecName: string): string | number;

Parse the version from ApiSpec resource.

Parameter
NameDescription
apiSpecName string

A fully-qualified path representing ApiSpec resource.

Returns
TypeDescription
string | number

{string} A string representing the version.

matchVersionFromApiVersionName(apiVersionName)

matchVersionFromApiVersionName(apiVersionName: string): string | number;

Parse the version from ApiVersion resource.

Parameter
NameDescription
apiVersionName string

A fully-qualified path representing ApiVersion resource.

Returns
TypeDescription
string | number

{string} A string representing the version.

matchVersionFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName)

matchVersionFromProjectLocationApiVersionArtifactName(projectLocationApiVersionArtifactName: string): string | number;

Parse the version from ProjectLocationApiVersionArtifact resource.

Parameter
NameDescription
projectLocationApiVersionArtifactName string

A fully-qualified path representing project_location_api_version_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the version.

matchVersionFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName)

matchVersionFromProjectLocationApiVersionSpecArtifactName(projectLocationApiVersionSpecArtifactName: string): string | number;

Parse the version from ProjectLocationApiVersionSpecArtifact resource.

Parameter
NameDescription
projectLocationApiVersionSpecArtifactName string

A fully-qualified path representing project_location_api_version_spec_artifact resource.

Returns
TypeDescription
string | number

{string} A string representing the version.

projectLocationApiArtifactPath(project, location, api, artifact)

projectLocationApiArtifactPath(project: string, location: string, api: string, artifact: string): string;

Return a fully-qualified projectLocationApiArtifact resource name string.

Parameters
NameDescription
project string
location string
api string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

projectLocationApiDeploymentArtifactPath(project, location, api, deployment, artifact)

projectLocationApiDeploymentArtifactPath(project: string, location: string, api: string, deployment: string, artifact: string): string;

Return a fully-qualified projectLocationApiDeploymentArtifact resource name string.

Parameters
NameDescription
project string
location string
api string
deployment string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

projectLocationApiVersionArtifactPath(project, location, api, version, artifact)

projectLocationApiVersionArtifactPath(project: string, location: string, api: string, version: string, artifact: string): string;

Return a fully-qualified projectLocationApiVersionArtifact resource name string.

Parameters
NameDescription
project string
location string
api string
version string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

projectLocationApiVersionSpecArtifactPath(project, location, api, version, spec, artifact)

projectLocationApiVersionSpecArtifactPath(project: string, location: string, api: string, version: string, spec: string, artifact: string): string;

Return a fully-qualified projectLocationApiVersionSpecArtifact resource name string.

Parameters
NameDescription
project string
location string
api string
version string
spec string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

projectLocationArtifactPath(project, location, artifact)

projectLocationArtifactPath(project: string, location: string, artifact: string): string;

Return a fully-qualified projectLocationArtifact resource name string.

Parameters
NameDescription
project string
location string
artifact string
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

replaceArtifact(request, options)

replaceArtifact(request?: protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IArtifact,
        protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest | undefined,
        {} | undefined
    ]>;

Used to replace a specified artifact.

Parameters
NameDescription
request IReplaceArtifactRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Artifact. 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 artifact to replace.
   *  The `name` field is used to identify the artifact to replace.
   *  Format: `{parent}/artifacts/*`
   */
  // const artifact = {}

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callReplaceArtifact() {
    // Construct request
    const request = {
      artifact,
    };

    // Run request
    const response = await apigeeregistryClient.replaceArtifact(request);
    console.log(response);
  }

  callReplaceArtifact();

replaceArtifact(request, options, callback)

replaceArtifact(request: protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IReplaceArtifactRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

replaceArtifact(request, callback)

replaceArtifact(request: protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IReplaceArtifactRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IArtifact, protos.google.cloud.apigeeregistry.v1.IReplaceArtifactRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

rollbackApiDeployment(request, options)

rollbackApiDeployment(request?: protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiDeployment,
        (protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest | undefined),
        {} | undefined
    ]>;

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Parameters
NameDescription
request IRollbackApiDeploymentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiDeployment, (protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApiDeployment. 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 deployment being rolled back.
   */
  // const name = 'abc123'
  /**
   *  Required. The revision ID to roll back to.
   *  It must be a revision of the same deployment.
   *    Example: `c7cfa2a8`
   */
  // const revisionId = 'abc123'

  // Imports the Apigeeregistry library
  const {RegistryClient} = require('@google-cloud/apigee-registry').v1;

  // Instantiates a client
  const apigeeregistryClient = new RegistryClient();

  async function callRollbackApiDeployment() {
    // Construct request
    const request = {
      name,
      revisionId,
    };

    // Run request
    const response = await apigeeregistryClient.rollbackApiDeployment(request);
    console.log(response);
  }

  callRollbackApiDeployment();

rollbackApiDeployment(request, options, callback)

rollbackApiDeployment(request: protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IRollbackApiDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

rollbackApiDeployment(request, callback)

rollbackApiDeployment(request: protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest, callback: Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IRollbackApiDeploymentRequest
callback Callback<protos.google.cloud.apigeeregistry.v1.IApiDeployment, protos.google.cloud.apigeeregistry.v1.IRollbackApiDeploymentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

rollbackApiSpec(request, options)

rollbackApiSpec(request?: protos.google.cloud.apigeeregistry.v1.IRollbackApiSpecRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigeeregistry.v1.IApiSpec,
        protos.google.cloud.apigeeregistry.v1.IRollbackApiSpecRequest | undefined,
        {} | undefined
    ]>;

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

Parameters
NameDescription
request IRollbackApiSpecRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.apigeeregistry.v1.IApiSpec, protos.google.cloud.apigeeregistry.v1.IRollbackApiSpecRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing