Class v1.VersionsClient (1.1.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

versionsStub

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

warn

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

Methods

checkCreateVersionProgress(name)

checkCreateVersionProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Version, protos.google.appengine.v1.CreateVersionMetadataV1>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the parent resource to create this version under. Example:
   *  `apps/myapp/services/default`.
   */
  // const parent = 'abc123'
  /**
   *  Application deployment configuration.
   */
  // const version = {}

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callCreateVersion() {
    // Construct request
    const request = {};

    // Run request
    const [operation] = await appengineClient.createVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateVersion();

checkDeleteVersionProgress(name)

checkDeleteVersionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.appengine.v1.OperationMetadataV1>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource requested. Example:
   *  `apps/myapp/services/default/versions/v1`.
   */
  // const name = 'abc123'

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callDeleteVersion() {
    // Construct request
    const request = {};

    // Run request
    const [operation] = await appengineClient.deleteVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteVersion();

checkUpdateVersionProgress(name)

checkUpdateVersionProgress(name: string): Promise<LROperation<protos.google.appengine.v1.Version, protos.google.appengine.v1.OperationMetadataV1>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource to update. Example:
   *  `apps/myapp/services/default/versions/1`.
   */
  // const name = 'abc123'
  /**
   *  A Version containing the updated resource. Only fields set in the field
   *  mask will be updated.
   */
  // const version = {}
  /**
   *  Standard field mask for the set of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callUpdateVersion() {
    // Construct request
    const request = {};

    // Run request
    const [operation] = await appengineClient.updateVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateVersion();

close()

close(): Promise<void>;

createVersion(request, options)

createVersion(request?: protos.google.appengine.v1.ICreateVersionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.ICreateVersionMetadataV1>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the parent resource to create this version under. Example:
   *  `apps/myapp/services/default`.
   */
  // const parent = 'abc123'
  /**
   *  Application deployment configuration.
   */
  // const version = {}

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callCreateVersion() {
    // Construct request
    const request = {};

    // Run request
    const [operation] = await appengineClient.createVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateVersion();

createVersion(request, options, callback)

createVersion(request: protos.google.appengine.v1.ICreateVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.ICreateVersionMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createVersion(request, callback)

createVersion(request: protos.google.appengine.v1.ICreateVersionRequest, callback: Callback<LROperation<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.ICreateVersionMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteVersion(request, options)

deleteVersion(request?: protos.google.appengine.v1.IDeleteVersionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource requested. Example:
   *  `apps/myapp/services/default/versions/v1`.
   */
  // const name = 'abc123'

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callDeleteVersion() {
    // Construct request
    const request = {};

    // Run request
    const [operation] = await appengineClient.deleteVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteVersion();

deleteVersion(request, options, callback)

deleteVersion(request: protos.google.appengine.v1.IDeleteVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteVersion(request, callback)

deleteVersion(request: protos.google.appengine.v1.IDeleteVersionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

getVersion(request, options)

getVersion(request?: protos.google.appengine.v1.IGetVersionRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IVersion,
        protos.google.appengine.v1.IGetVersionRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource requested. Example:
   *  `apps/myapp/services/default/versions/v1`.
   */
  // const name = 'abc123'
  /**
   *  Controls the set of fields returned in the `Get` response.
   */
  // const view = {}

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callGetVersion() {
    // Construct request
    const request = {};

    // Run request
    const response = await appengineClient.getVersion(request);
    console.log(response);
  }

  callGetVersion();

getVersion(request, options, callback)

getVersion(request: protos.google.appengine.v1.IGetVersionRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.IGetVersionRequest | null | undefined, {} | null | undefined>): void;

getVersion(request, callback)

getVersion(request: protos.google.appengine.v1.IGetVersionRequest, callback: Callback<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.IGetVersionRequest | null | undefined, {} | null | undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

instancePath(app, service, version, instance)

instancePath(app: string, service: string, version: string, instance: string): string;

listVersions(request, options)

listVersions(request?: protos.google.appengine.v1.IListVersionsRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IVersion[],
        protos.google.appengine.v1.IListVersionsRequest | null,
        protos.google.appengine.v1.IListVersionsResponse
    ]>;

listVersions(request, options, callback)

listVersions(request: protos.google.appengine.v1.IListVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.appengine.v1.IListVersionsRequest, protos.google.appengine.v1.IListVersionsResponse | null | undefined, protos.google.appengine.v1.IVersion>): void;

listVersions(request, callback)

listVersions(request: protos.google.appengine.v1.IListVersionsRequest, callback: PaginationCallback<protos.google.appengine.v1.IListVersionsRequest, protos.google.appengine.v1.IListVersionsResponse | null | undefined, protos.google.appengine.v1.IVersion>): void;

listVersionsAsync(request, options)

listVersionsAsync(request?: protos.google.appengine.v1.IListVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.appengine.v1.IVersion>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the parent Service resource. Example:
   *  `apps/myapp/services/default`.
   */
  // const parent = 'abc123'
  /**
   *  Controls the set of fields returned in the `List` response.
   */
  // const view = {}
  /**
   *  Maximum results to return per page.
   */
  // const pageSize = 1234
  /**
   *  Continuation token for fetching the next page of results.
   */
  // const pageToken = 'abc123'

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callListVersions() {
    // Construct request
    const request = {};

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

  callListVersions();

listVersionsStream(request, options)

listVersionsStream(request?: protos.google.appengine.v1.IListVersionsRequest, options?: CallOptions): Transform;

matchAppFromInstanceName(instanceName)

matchAppFromInstanceName(instanceName: string): string | number;

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

matchServiceFromInstanceName(instanceName)

matchServiceFromInstanceName(instanceName: string): string | number;

matchVersionFromInstanceName(instanceName)

matchVersionFromInstanceName(instanceName: string): string | number;

updateVersion(request, options)

updateVersion(request?: protos.google.appengine.v1.IUpdateVersionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.IOperationMetadataV1>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the resource to update. Example:
   *  `apps/myapp/services/default/versions/1`.
   */
  // const name = 'abc123'
  /**
   *  A Version containing the updated resource. Only fields set in the field
   *  mask will be updated.
   */
  // const version = {}
  /**
   *  Standard field mask for the set of fields to be updated.
   */
  // const updateMask = {}

  // Imports the Appengine library
  const {VersionsClient} = require('@google-cloud/appengine-admin').v1;

  // Instantiates a client
  const appengineClient = new VersionsClient();

  async function callUpdateVersion() {
    // Construct request
    const request = {};

    // Run request
    const [operation] = await appengineClient.updateVersion(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateVersion();

updateVersion(request, options, callback)

updateVersion(request: protos.google.appengine.v1.IUpdateVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateVersion(request, callback)

updateVersion(request: protos.google.appengine.v1.IUpdateVersionRequest, callback: Callback<LROperation<protos.google.appengine.v1.IVersion, protos.google.appengine.v1.IOperationMetadataV1>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;