FunctionServiceClient - Documentation

Constructor

new FunctionServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of FunctionServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

buildPath(project, location, build) → {string}

Return a fully-qualified build resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`build`	string

Returns:

Type	Description
string	Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be cancelled.

options

Object

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

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

channelPath(project, location, channel) → {string}

Return a fully-qualified channel resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`channel`	string

Returns:

Type	Description
string	Resource name string.

(async) checkCreateFunctionProgress(name) → {Promise}

Check the status of the long running operation returned by createFunction().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 project and location in which the function should be created,
   *  specified in the format `projects/* /locations/*`
   */
  // const parent = 'abc123'
  /**
   *  Required. Function to be created.
   */
  // const function = {}
  /**
   *  The ID to use for the function, which will become the final component of
   *  the function's resource name.
   *  This value should be 4-63 characters, and valid characters
   *  are /[a-z][0-9]-/.
   */
  // const functionId = 'abc123'

  // Imports the Functions library
  const {FunctionServiceClient} = require('@google-cloud/functions').v2;

  // Instantiates a client
  const functionsClient = new FunctionServiceClient();

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

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

  callCreateFunction();

(async) checkDeleteFunctionProgress(name) → {Promise}

Check the status of the long running operation returned by deleteFunction().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 function which should be deleted.
   */
  // const name = 'abc123'

  // Imports the Functions library
  const {FunctionServiceClient} = require('@google-cloud/functions').v2;

  // Instantiates a client
  const functionsClient = new FunctionServiceClient();

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

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

  callDeleteFunction();

(async) checkUpdateFunctionProgress(name) → {Promise}

Check the status of the long running operation returned by updateFunction().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. New version of the function.
   */
  // const function = {}
  /**
   *  The list of fields to be updated.
   *  If no field mask is provided, all fields will be updated.
   */
  // const updateMask = {}

  // Imports the Functions library
  const {FunctionServiceClient} = require('@google-cloud/functions').v2;

  // Instantiates a client
  const functionsClient = new FunctionServiceClient();

  async function callUpdateFunction() {
    // Construct request
    const request = {
      function1,
    };

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

  callUpdateFunction();

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

connectorPath(project, location, connector) → {string}

Return a fully-qualified connector resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`connector`	string

Returns:

Type	Description
string	Resource name string.

cryptoKeyPath(project, location, key_ring, crypto_key) → {string}

Return a fully-qualified cryptoKey resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`key_ring`	string
`crypto_key`	string

Returns:

Type	Description
string	Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource to be deleted.

options

Object

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

callback

function

The function which will be called with the result of the API call.

Returns:

Type	Description
Promise	The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

functionPath(project, location, functionParam) → {string}

Return a fully-qualified function resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`functionParam`	string

Returns:

Type	Description
string	Resource name string.

getIamPolicy(request, optionsopt, callbackopt) → {Promise}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

resource

string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options

Object

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions.

options

Object

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

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Resource name for the location.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.

Example

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

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The name of the operation resource.

options

Object

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

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.

Example

```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listFunctionsAsync(request, optionsopt) → {Object}

Equivalent to listFunctions, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project and location from which the function should be listed, specified in the format `projects/* /locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
`pageSize`	number	Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.
`pageToken`	string	The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.
`filter`	string	The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
`orderBy`	string	The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Function. 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 project and location from which the function should be
   *  listed, specified in the format `projects/* /locations/*` If you want to
   *  list functions in all locations, use "-" in place of a location. When
   *  listing functions in all locations, if one or more location(s) are
   *  unreachable, the response will contain functions from all reachable
   *  locations along with the names of any unreachable locations.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of functions to return per call. The largest allowed
   *  page_size is 1,000, if the page_size is omitted or specified as greater
   *  than 1,000 then it will be replaced as 1,000. The size of the list
   *  response can be less than specified when used with filters.
   */
  // const pageSize = 1234
  /**
   *  The value returned by the last
   *  `ListFunctionsResponse`; indicates that
   *  this is a continuation of a prior `ListFunctions` call, and that the
   *  system should return the next page of data.
   */
  // const pageToken = 'abc123'
  /**
   *  The filter for Functions that match the filter expression,
   *  following the syntax outlined in https://google.aip.dev/160.
   */
  // const filter = 'abc123'
  /**
   *  The sorting order of the resources returned. Value should be a comma
   *  separated list of fields. The default sorting oder is ascending.
   *  See https://google.aip.dev/132#ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Functions library
  const {FunctionServiceClient} = require('@google-cloud/functions').v2;

  // Instantiates a client
  const functionsClient = new FunctionServiceClient();

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

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

  callListFunctions();

listFunctionsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project and location from which the function should be listed, specified in the format `projects/* /locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
`pageSize`	number	Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.
`pageToken`	string	The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.
`filter`	string	The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
`orderBy`	string	The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.

options

object

Call options. See CallOptions for more details.

Returns:

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

listLocationsAsync(request, optionsopt) → {Object}

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:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The resource that owns the locations collection, if applicable.
`filter`	string	The standard list filter.
`pageSize`	number	The standard list page size.
`pageToken`	string	The standard list page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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
}
```

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`name`	string		The name of the operation collection.
`filter`	string		The standard list filter.
`pageSize`	number	<optional>	The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Object

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

Returns:

Type	Description
Object	An iterable Object that conforms to iteration protocols.

Example

```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

matchBuildFromBuildName(buildName) → {string}

Parse the build from Build resource.

Parameters:

Name	Type	Description
`buildName`	string	A fully-qualified path representing Build resource.

Returns:

Type	Description
string	A string representing the build.

matchChannelFromChannelName(channelName) → {string}

Parse the channel from Channel resource.

Parameters:

Name	Type	Description
`channelName`	string	A fully-qualified path representing Channel resource.

Returns:

Type	Description
string	A string representing the channel.

matchConnectorFromConnectorName(connectorName) → {string}

Parse the connector from Connector resource.

Parameters:

Name	Type	Description
`connectorName`	string	A fully-qualified path representing Connector resource.

Returns:

Type	Description
string	A string representing the connector.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName) → {string}

Parse the crypto_key from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the crypto_key.

matchFunctionFromFunctionName(functionName) → {string}

Parse the function from Function resource.

Parameters:

Name	Type	Description
`functionName`	string	A fully-qualified path representing Function resource.

Returns:

Type	Description
string	A string representing the function.

matchKeyRingFromCryptoKeyName(cryptoKeyName) → {string}

Parse the key_ring from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the key_ring.

matchLocationFromBuildName(buildName) → {string}

Parse the location from Build resource.

Parameters:

Name	Type	Description
`buildName`	string	A fully-qualified path representing Build resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromChannelName(channelName) → {string}

Parse the location from Channel resource.

Parameters:

Name	Type	Description
`channelName`	string	A fully-qualified path representing Channel resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromConnectorName(connectorName) → {string}

Parse the location from Connector resource.

Parameters:

Name	Type	Description
`connectorName`	string	A fully-qualified path representing Connector resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromCryptoKeyName(cryptoKeyName) → {string}

Parse the location from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFunctionName(functionName) → {string}

Parse the location from Function resource.

Parameters:

Name	Type	Description
`functionName`	string	A fully-qualified path representing Function resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromRepositoryName(repositoryName) → {string}

Parse the location from Repository resource.

Parameters:

Name	Type	Description
`repositoryName`	string	A fully-qualified path representing Repository resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromServiceName(serviceName) → {string}

Parse the location from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTriggerName(triggerName) → {string}

Parse the location from Trigger resource.

Parameters:

Name	Type	Description
`triggerName`	string	A fully-qualified path representing Trigger resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromWorkerPoolName(workerPoolName) → {string}

Parse the location from WorkerPool resource.

Parameters:

Name	Type	Description
`workerPoolName`	string	A fully-qualified path representing WorkerPool resource.

Returns:

Type	Description
string	A string representing the location.

matchProjectFromBuildName(buildName) → {string}

Parse the project from Build resource.

Parameters:

Name	Type	Description
`buildName`	string	A fully-qualified path representing Build resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromChannelName(channelName) → {string}

Parse the project from Channel resource.

Parameters:

Name	Type	Description
`channelName`	string	A fully-qualified path representing Channel resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromConnectorName(connectorName) → {string}

Parse the project from Connector resource.

Parameters:

Name	Type	Description
`connectorName`	string	A fully-qualified path representing Connector resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromCryptoKeyName(cryptoKeyName) → {string}

Parse the project from CryptoKey resource.

Parameters:

Name	Type	Description
`cryptoKeyName`	string	A fully-qualified path representing CryptoKey resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFunctionName(functionName) → {string}

Parse the project from Function resource.

Parameters:

Name	Type	Description
`functionName`	string	A fully-qualified path representing Function resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromRepositoryName(repositoryName) → {string}

Parse the project from Repository resource.

Parameters:

Name	Type	Description
`repositoryName`	string	A fully-qualified path representing Repository resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromServiceName(serviceName) → {string}

Parse the project from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTopicName(topicName) → {string}

Parse the project from Topic resource.

Parameters:

Name	Type	Description
`topicName`	string	A fully-qualified path representing Topic resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTriggerName(triggerName) → {string}

Parse the project from Trigger resource.

Parameters:

Name	Type	Description
`triggerName`	string	A fully-qualified path representing Trigger resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromWorkerPoolName(workerPoolName) → {string}

Parse the project from WorkerPool resource.

Parameters:

Name	Type	Description
`workerPoolName`	string	A fully-qualified path representing WorkerPool resource.

Returns:

Type	Description
string	A string representing the project.

matchRepositoryFromRepositoryName(repositoryName) → {string}

Parse the repository from Repository resource.

Parameters:

Name	Type	Description
`repositoryName`	string	A fully-qualified path representing Repository resource.

Returns:

Type	Description
string	A string representing the repository.

matchServiceFromServiceName(serviceName) → {string}

Parse the service from Service resource.

Parameters:

Name	Type	Description
`serviceName`	string	A fully-qualified path representing Service resource.

Returns:

Type	Description
string	A string representing the service.

matchTopicFromTopicName(topicName) → {string}

Parse the topic from Topic resource.

Parameters:

Name	Type	Description
`topicName`	string	A fully-qualified path representing Topic resource.

Returns:

Type	Description
string	A string representing the topic.

matchTriggerFromTriggerName(triggerName) → {string}

Parse the trigger from Trigger resource.

Parameters:

Name	Type	Description
`triggerName`	string	A fully-qualified path representing Trigger resource.

Returns:

Type	Description
string	A string representing the trigger.

matchWorkerPoolFromWorkerPoolName(workerPoolName) → {string}

Parse the worker_pool from WorkerPool resource.

Parameters:

Name	Type	Description
`workerPoolName`	string	A fully-qualified path representing WorkerPool resource.

Returns:

Type	Description
string	A string representing the worker_pool.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

repositoryPath(project, location, repository) → {string}

Return a fully-qualified repository resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`repository`	string

Returns:

Type	Description
string	Resource name string.

servicePath(project, location, service) → {string}

Return a fully-qualified service resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`service`	string

Returns:

Type	Description
string	Resource name string.

setIamPolicy(request, optionsopt, callbackopt) → {Promise}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

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

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request, optionsopt, callbackopt) → {Promise}

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`resource`	string	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
`permissions`	Array.<string>	The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Object

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

callback

function

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

topicPath(project, topic) → {string}

Return a fully-qualified topic resource name string.

Parameters:

Name	Type	Description
`project`	string
`topic`	string

Returns:

Type	Description
string	Resource name string.

triggerPath(project, location, trigger) → {string}

Return a fully-qualified trigger resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`trigger`	string

Returns:

Type	Description
string	Resource name string.

workerPoolPath(project, location, worker_pool) → {string}

Return a fully-qualified workerPool resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`worker_pool`	string

Returns:

Type	Description
string	Resource name string.