Class v1.EventarcClient (1.1.2)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

eventarcStub

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

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

checkCreateTriggerProgress(name)

checkCreateTriggerProgress(name: string): Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger, protos.google.cloud.eventarc.v1.OperationMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent collection in which to add this trigger.
   */
  // const parent = 'abc123'
  /**
   *  Required. The trigger to create.
   */
  // const trigger = {}
  /**
   *  Required. The user-provided ID to be assigned to the trigger.
   */
  // const triggerId = 'abc123'
  /**
   *  Required. If set, validate the request and preview the review, but do not actually
   *  post it.
   */
  // const validateOnly = true

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callCreateTrigger() {
    // Construct request
    const request = {
      parent,
      trigger,
      triggerId,
      validateOnly,
    };

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

  callCreateTrigger();

checkDeleteTriggerProgress(name)

checkDeleteTriggerProgress(name: string): Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger, protos.google.cloud.eventarc.v1.OperationMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the trigger to be deleted.
   */
  // const name = 'abc123'
  /**
   *  If provided, the trigger will only be deleted if the etag matches the
   *  current etag on the resource.
   */
  // const etag = 'abc123'
  /**
   *  If set to true, and the trigger is not found, the request will succeed
   *  but no action will be taken on the server.
   */
  // const allowMissing = true
  /**
   *  Required. If set, validate the request and preview the review, but do not actually
   *  post it.
   */
  // const validateOnly = true

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

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

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

  callDeleteTrigger();

checkUpdateTriggerProgress(name)

checkUpdateTriggerProgress(name: string): Promise<LROperation<protos.google.cloud.eventarc.v1.Trigger, protos.google.cloud.eventarc.v1.OperationMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The trigger to be updated.
   */
  // const trigger = {}
  /**
   *  The fields to be updated; only fields explicitly provided will be updated.
   *  If no field mask is provided, all provided fields in the request will be
   *  updated. To update all fields, provide a field mask of "*".
   */
  // const updateMask = {}
  /**
   *  If set to true, and the trigger is not found, a new trigger will be
   *  created. In this situation, `update_mask` is ignored.
   */
  // const allowMissing = true
  /**
   *  Required. If set, validate the request and preview the review, but do not actually
   *  post it.
   */
  // const validateOnly = true

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callUpdateTrigger() {
    // Construct request
    const request = {
      validateOnly,
    };

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

  callUpdateTrigger();

close()

close(): Promise<void>;

createTrigger(request, options)

createTrigger(request?: protos.google.cloud.eventarc.v1.ICreateTriggerRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent collection in which to add this trigger.
   */
  // const parent = 'abc123'
  /**
   *  Required. The trigger to create.
   */
  // const trigger = {}
  /**
   *  Required. The user-provided ID to be assigned to the trigger.
   */
  // const triggerId = 'abc123'
  /**
   *  Required. If set, validate the request and preview the review, but do not actually
   *  post it.
   */
  // const validateOnly = true

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callCreateTrigger() {
    // Construct request
    const request = {
      parent,
      trigger,
      triggerId,
      validateOnly,
    };

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

  callCreateTrigger();

createTrigger(request, options, callback)

createTrigger(request: protos.google.cloud.eventarc.v1.ICreateTriggerRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createTrigger(request, callback)

createTrigger(request: protos.google.cloud.eventarc.v1.ICreateTriggerRequest, callback: Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteTrigger(request, options)

deleteTrigger(request?: protos.google.cloud.eventarc.v1.IDeleteTriggerRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the trigger to be deleted.
   */
  // const name = 'abc123'
  /**
   *  If provided, the trigger will only be deleted if the etag matches the
   *  current etag on the resource.
   */
  // const etag = 'abc123'
  /**
   *  If set to true, and the trigger is not found, the request will succeed
   *  but no action will be taken on the server.
   */
  // const allowMissing = true
  /**
   *  Required. If set, validate the request and preview the review, but do not actually
   *  post it.
   */
  // const validateOnly = true

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

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

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

  callDeleteTrigger();

deleteTrigger(request, options, callback)

deleteTrigger(request: protos.google.cloud.eventarc.v1.IDeleteTriggerRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteTrigger(request, callback)

deleteTrigger(request: protos.google.cloud.eventarc.v1.IDeleteTriggerRequest, callback: Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

getTrigger(request, options)

getTrigger(request?: protos.google.cloud.eventarc.v1.IGetTriggerRequest, options?: CallOptions): Promise<[
        protos.google.cloud.eventarc.v1.ITrigger,
        protos.google.cloud.eventarc.v1.IGetTriggerRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the trigger to get.
   */
  // const name = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

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

    // Run request
    const response = await eventarcClient.getTrigger(request);
    console.log(response);
  }

  callGetTrigger();

getTrigger(request, options, callback)

getTrigger(request: protos.google.cloud.eventarc.v1.IGetTriggerRequest, options: CallOptions, callback: Callback<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IGetTriggerRequest | null | undefined, {} | null | undefined>): void;

getTrigger(request, callback)

getTrigger(request: protos.google.cloud.eventarc.v1.IGetTriggerRequest, callback: Callback<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IGetTriggerRequest | null | undefined, {} | null | undefined>): void;

initialize()

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

listTriggers(request, options)

listTriggers(request?: protos.google.cloud.eventarc.v1.IListTriggersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.eventarc.v1.ITrigger[],
        protos.google.cloud.eventarc.v1.IListTriggersRequest | null,
        protos.google.cloud.eventarc.v1.IListTriggersResponse
    ]>;

listTriggers(request, options, callback)

listTriggers(request: protos.google.cloud.eventarc.v1.IListTriggersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest, protos.google.cloud.eventarc.v1.IListTriggersResponse | null | undefined, protos.google.cloud.eventarc.v1.ITrigger>): void;

listTriggers(request, callback)

listTriggers(request: protos.google.cloud.eventarc.v1.IListTriggersRequest, callback: PaginationCallback<protos.google.cloud.eventarc.v1.IListTriggersRequest, protos.google.cloud.eventarc.v1.IListTriggersResponse | null | undefined, protos.google.cloud.eventarc.v1.ITrigger>): void;

listTriggersAsync(request, options)

listTriggersAsync(request?: protos.google.cloud.eventarc.v1.IListTriggersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.eventarc.v1.ITrigger>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent collection to list triggers on.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of triggers to return on each page.
   *  Note: The service may send fewer.
   */
  // const pageSize = 1234
  /**
   *  The page token; provide the value from the `next_page_token` field in a
   *  previous `ListTriggers` call to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListTriggers` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  The sorting order of the resources returned. Value should be a comma
   *  separated list of fields. The default sorting oder is ascending. To specify
   *  descending order for a field, append a ` desc` suffix; for example:
   *  `name desc, trigger_id`.
   */
  // const orderBy = 'abc123'

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

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

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

  callListTriggers();

listTriggersStream(request, options)

listTriggersStream(request?: protos.google.cloud.eventarc.v1.IListTriggersRequest, options?: CallOptions): Transform;

locationPath(project, location)

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

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

matchLocationFromTriggerName(triggerName)

matchLocationFromTriggerName(triggerName: string): string | number;

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

matchProjectFromTriggerName(triggerName)

matchProjectFromTriggerName(triggerName: string): string | number;

matchTriggerFromTriggerName(triggerName)

matchTriggerFromTriggerName(triggerName: string): string | number;

projectPath(project)

projectPath(project: string): string;

triggerPath(project, location, trigger)

triggerPath(project: string, location: string, trigger: string): string;

updateTrigger(request, options)

updateTrigger(request?: protos.google.cloud.eventarc.v1.IUpdateTriggerRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The trigger to be updated.
   */
  // const trigger = {}
  /**
   *  The fields to be updated; only fields explicitly provided will be updated.
   *  If no field mask is provided, all provided fields in the request will be
   *  updated. To update all fields, provide a field mask of "*".
   */
  // const updateMask = {}
  /**
   *  If set to true, and the trigger is not found, a new trigger will be
   *  created. In this situation, `update_mask` is ignored.
   */
  // const allowMissing = true
  /**
   *  Required. If set, validate the request and preview the review, but do not actually
   *  post it.
   */
  // const validateOnly = true

  // Imports the Eventarc library
  const {EventarcClient} = require('@google-cloud/eventarc').v1;

  // Instantiates a client
  const eventarcClient = new EventarcClient();

  async function callUpdateTrigger() {
    // Construct request
    const request = {
      validateOnly,
    };

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

  callUpdateTrigger();

updateTrigger(request, options, callback)

updateTrigger(request: protos.google.cloud.eventarc.v1.IUpdateTriggerRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateTrigger(request, callback)

updateTrigger(request: protos.google.cloud.eventarc.v1.IUpdateTriggerRequest, callback: Callback<LROperation<protos.google.cloud.eventarc.v1.ITrigger, protos.google.cloud.eventarc.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;