Class v1.CloudMemcacheClient (2.1.4)

Package

Constructors

(constructor)(opts, gaxInstance)

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

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

cloudMemcacheStub

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

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;

warn

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

Methods

applyParameters(request, options)

applyParameters(request?: protos.google.cloud.memcache.v1.IApplyParametersRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * 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. Resource name of the Memcached instance for which parameter group updates
   *  should be applied.
   */
  // const name = 'abc123'
  /**
   *  Nodes to which we should apply the instance-level parameter group.
   */
  // const nodeIds = 'abc123'
  /**
   *  Whether to apply instance-level parameter group to all nodes. If set to
   *  true, will explicitly restrict users from specifying any nodes, and apply
   *  parameter group updates to all nodes within the instance.
   */
  // const applyAll = true

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callApplyParameters();

applyParameters(request, options, callback)

applyParameters(request: protos.google.cloud.memcache.v1.IApplyParametersRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

applyParameters(request, callback)

applyParameters(request: protos.google.cloud.memcache.v1.IApplyParametersRequest, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

checkApplyParametersProgress(name)

checkApplyParametersProgress(name: string): Promise<LROperation<protos.google.cloud.memcache.v1.Instance, protos.google.cloud.memcache.v1.OperationMetadata>>;

  /**
   * 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. Resource name of the Memcached instance for which parameter group updates
   *  should be applied.
   */
  // const name = 'abc123'
  /**
   *  Nodes to which we should apply the instance-level parameter group.
   */
  // const nodeIds = 'abc123'
  /**
   *  Whether to apply instance-level parameter group to all nodes. If set to
   *  true, will explicitly restrict users from specifying any nodes, and apply
   *  parameter group updates to all nodes within the instance.
   */
  // const applyAll = true

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callApplyParameters();

checkCreateInstanceProgress(name)

checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memcache.v1.Instance, protos.google.cloud.memcache.v1.OperationMetadata>>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the instance location using the form:
   *      `projects/{project_id}/locations/{location_id}`
   *  where `location_id` refers to a GCP region
   */
  // const parent = 'abc123'
  /**
   *  Required. The logical name of the Memcached instance in the user
   *  project with the following restrictions:
   *  * Must contain only lowercase letters, numbers, and hyphens.
   *  * Must start with a letter.
   *  * Must be between 1-40 characters.
   *  * Must end with a number or a letter.
   *  * Must be unique within the user project / location
   *  If any of the above are not met, will raise an invalid argument error.
   */
  // const instanceId = 'abc123'
  /**
   *  Required. A Memcached Instance
   */
  // const instance = {}

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

  async function callCreateInstance() {
    // Construct request
    const request = {
      parent,
      instanceId,
      instance,
    };

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

  callCreateInstance();

checkDeleteInstanceProgress(name)

checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.memcache.v1.OperationMetadata>>;

  /**
   * 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. Memcached instance resource name in the format:
   *      `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
   *  where `location_id` refers to a GCP region
   */
  // const name = 'abc123'

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callDeleteInstance();

checkUpdateInstanceProgress(name)

checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.memcache.v1.Instance, protos.google.cloud.memcache.v1.OperationMetadata>>;

  /**
   * 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. Mask of fields to update.
   *   *   `displayName`
   */
  // const updateMask = {}
  /**
   *  Required. A Memcached Instance.
   *  Only fields specified in update_mask are updated.
   */
  // const instance = {}

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

  async function callUpdateInstance() {
    // Construct request
    const request = {
      updateMask,
      instance,
    };

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

  callUpdateInstance();

checkUpdateParametersProgress(name)

checkUpdateParametersProgress(name: string): Promise<LROperation<protos.google.cloud.memcache.v1.Instance, protos.google.cloud.memcache.v1.OperationMetadata>>;

  /**
   * 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. Resource name of the Memcached instance for which the parameters should be
   *  updated.
   */
  // const name = 'abc123'
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  The parameters to apply to the instance.
   */
  // const parameters = {}

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callUpdateParameters();

close()

close(): Promise<void>;

createInstance(request, options)

createInstance(request?: protos.google.cloud.memcache.v1.ICreateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the instance location using the form:
   *      `projects/{project_id}/locations/{location_id}`
   *  where `location_id` refers to a GCP region
   */
  // const parent = 'abc123'
  /**
   *  Required. The logical name of the Memcached instance in the user
   *  project with the following restrictions:
   *  * Must contain only lowercase letters, numbers, and hyphens.
   *  * Must start with a letter.
   *  * Must be between 1-40 characters.
   *  * Must end with a number or a letter.
   *  * Must be unique within the user project / location
   *  If any of the above are not met, will raise an invalid argument error.
   */
  // const instanceId = 'abc123'
  /**
   *  Required. A Memcached Instance
   */
  // const instance = {}

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

  async function callCreateInstance() {
    // Construct request
    const request = {
      parent,
      instanceId,
      instance,
    };

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

  callCreateInstance();

createInstance(request, options, callback)

createInstance(request: protos.google.cloud.memcache.v1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createInstance(request, callback)

createInstance(request: protos.google.cloud.memcache.v1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteInstance(request, options)

deleteInstance(request?: protos.google.cloud.memcache.v1.IDeleteInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memcache.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * 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. Memcached instance resource name in the format:
   *      `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
   *  where `location_id` refers to a GCP region
   */
  // const name = 'abc123'

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callDeleteInstance();

deleteInstance(request, options, callback)

deleteInstance(request: protos.google.cloud.memcache.v1.IDeleteInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteInstance(request, callback)

deleteInstance(request: protos.google.cloud.memcache.v1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

getInstance(request, options)

getInstance(request?: protos.google.cloud.memcache.v1.IGetInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.memcache.v1.IInstance,
        protos.google.cloud.memcache.v1.IGetInstanceRequest | undefined,
        {} | undefined
    ]>;

  /**
   * 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. Memcached instance resource name in the format:
   *      `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
   *  where `location_id` refers to a GCP region
   */
  // const name = 'abc123'

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

    // Run request
    const response = await memcacheClient.getInstance(request);
    console.log(response);
  }

  callGetInstance();

getInstance(request, options, callback)

getInstance(request: protos.google.cloud.memcache.v1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;

getInstance(request, callback)

getInstance(request: protos.google.cloud.memcache.v1.IGetInstanceRequest, callback: Callback<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

initialize()

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

instancePath(project, location, instance)

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

listInstances(request, options)

listInstances(request?: protos.google.cloud.memcache.v1.IListInstancesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.memcache.v1.IInstance[],
        protos.google.cloud.memcache.v1.IListInstancesRequest | null,
        protos.google.cloud.memcache.v1.IListInstancesResponse
    ]>;

listInstances(request, options, callback)

listInstances(request: protos.google.cloud.memcache.v1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.memcache.v1.IListInstancesRequest, protos.google.cloud.memcache.v1.IListInstancesResponse | null | undefined, protos.google.cloud.memcache.v1.IInstance>): void;

listInstances(request, callback)

listInstances(request: protos.google.cloud.memcache.v1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.memcache.v1.IListInstancesRequest, protos.google.cloud.memcache.v1.IListInstancesResponse | null | undefined, protos.google.cloud.memcache.v1.IInstance>): void;

listInstancesAsync(request, options)

listInstancesAsync(request?: protos.google.cloud.memcache.v1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.memcache.v1.IInstance>;

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the instance location using the form:
   *      `projects/{project_id}/locations/{location_id}`
   *  where `location_id` refers to a GCP region
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return.
   *  If not specified, a default value of 1000 will be used by the service.
   *  Regardless of the page_size value, the response may include a partial list
   *  and a caller should only rely on response's
   *  next_page_token CloudMemcache.ListInstancesResponse.next_page_token 
   *  to determine if there are more instances left to be queried.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request,
   *  if any.
   */
  // const pageToken = 'abc123'
  /**
   *  List filter. For example, exclude all Memcached instances with name as
   *  my-instance by specifying "name != my-instance".
   */
  // const filter = 'abc123'
  /**
   *  Sort results. Supported values are "name", "name desc" or "" (unsorted).
   */
  // const orderBy = 'abc123'

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callListInstances();

listInstancesStream(request, options)

listInstancesStream(request?: protos.google.cloud.memcache.v1.IListInstancesRequest, options?: CallOptions): Transform;

locationPath(project, location)

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

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

updateInstance(request, options)

updateInstance(request?: protos.google.cloud.memcache.v1.IUpdateInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * 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. Mask of fields to update.
   *   *   `displayName`
   */
  // const updateMask = {}
  /**
   *  Required. A Memcached Instance.
   *  Only fields specified in update_mask are updated.
   */
  // const instance = {}

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

  async function callUpdateInstance() {
    // Construct request
    const request = {
      updateMask,
      instance,
    };

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

  callUpdateInstance();

updateInstance(request, options, callback)

updateInstance(request: protos.google.cloud.memcache.v1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateInstance(request, callback)

updateInstance(request: protos.google.cloud.memcache.v1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateParameters(request, options)

updateParameters(request?: protos.google.cloud.memcache.v1.IUpdateParametersRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * 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. Resource name of the Memcached instance for which the parameters should be
   *  updated.
   */
  // const name = 'abc123'
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  The parameters to apply to the instance.
   */
  // const parameters = {}

  // Imports the Memcache library
  const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;

  // Instantiates a client
  const memcacheClient = new CloudMemcacheClient();

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

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

  callUpdateParameters();

updateParameters(request, options, callback)

updateParameters(request: protos.google.cloud.memcache.v1.IUpdateParametersRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateParameters(request, callback)

updateParameters(request: protos.google.cloud.memcache.v1.IUpdateParametersRequest, callback: Callback<LROperation<protos.google.cloud.memcache.v1.IInstance, protos.google.cloud.memcache.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;