ConfigServiceV2Client - Documentation

Constructor

new ConfigServiceV2Client(optionsopt, gaxInstanceopt)

Construct an instance of ConfigServiceV2Client.

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 ConfigServiceV2Client({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

billingAccountCmekSettingsPath(billing_account) → {string}

Return a fully-qualified billingAccountCmekSettings resource name string.

Parameters:

Name	Type	Description
`billing_account`	string

Returns:

Type	Description
string	Resource name string.

billingAccountExclusionPath(billing_account, exclusion) → {string}

Return a fully-qualified billingAccountExclusion resource name string.

Parameters:

Name	Type	Description
`billing_account`	string
`exclusion`	string

Returns:

Type	Description
string	Resource name string.

billingAccountLocationBucketLinkPath(billing_account, location, bucket, link) → {string}

Return a fully-qualified billingAccountLocationBucketLink resource name string.

Parameters:

Name	Type	Description
`billing_account`	string
`location`	string
`bucket`	string
`link`	string

Returns:

Type	Description
string	Resource name string.

billingAccountLocationBucketPath(billing_account, location, bucket) → {string}

Return a fully-qualified billingAccountLocationBucket resource name string.

Parameters:

Name	Type	Description
`billing_account`	string
`location`	string
`bucket`	string

Returns:

Type	Description
string	Resource name string.

billingAccountLocationBucketViewPath(billing_account, location, bucket, view) → {string}

Return a fully-qualified billingAccountLocationBucketView resource name string.

Parameters:

Name	Type	Description
`billing_account`	string
`location`	string
`bucket`	string
`view`	string

Returns:

Type	Description
string	Resource name string.

billingAccountLogPath(billing_account, log) → {string}

Return a fully-qualified billingAccountLog resource name string.

Parameters:

Name	Type	Description
`billing_account`	string
`log`	string

Returns:

Type	Description
string	Resource name string.

billingAccountSettingsPath(billing_account) → {string}

Return a fully-qualified billingAccountSettings resource name string.

Parameters:

Name	Type	Description
`billing_account`	string

Returns:

Type	Description
string	Resource name string.

billingAccountSinkPath(billing_account, sink) → {string}

Return a fully-qualified billingAccountSink resource name string.

Parameters:

Name	Type	Description
`billing_account`	string
`sink`	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: ''});
```

(async) checkCopyLogEntriesProgress(name) → {Promise}

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

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. Log bucket from which to copy log entries.
   *  For example:
   *    `"projects/my-project/locations/global/buckets/my-source-bucket"`
   */
  // const name = 'abc123'
  /**
   *  Optional. A filter specifying which log entries to copy. The filter must be
   *  no more than 20k characters. An empty filter matches all log entries.
   */
  // const filter = 'abc123'
  /**
   *  Required. Destination to which to copy log entries.
   */
  // const destination = 'abc123'

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callCopyLogEntries();

(async) checkCreateBucketAsyncProgress(name) → {Promise}

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

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 resource in which to create the log bucket:
   *      "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
   *  For example:
   *    `"projects/my-project/locations/global"`
   */
  // const parent = 'abc123'
  /**
   *  Required. A client-assigned identifier such as `"my-bucket"`. Identifiers
   *  are limited to 100 characters and can include only letters, digits,
   *  underscores, hyphens, and periods.
   */
  // const bucketId = 'abc123'
  /**
   *  Required. The new bucket. The region specified in the new bucket must be
   *  compliant with any Location Restriction Org Policy. The name field in the
   *  bucket is ignored.
   */
  // const bucket = {}

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

  async function callCreateBucketAsync() {
    // Construct request
    const request = {
      parent,
      bucketId,
      bucket,
    };

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

  callCreateBucketAsync();

(async) checkCreateLinkProgress(name) → {Promise}

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

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 full resource name of the bucket to create a link for.
   *      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *      "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *      "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *      "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   */
  // const parent = 'abc123'
  /**
   *  Required. The new link.
   */
  // const link = {}
  /**
   *  Required. The ID to use for the link. The link_id can have up to 100
   *  characters. A valid link_id must only have alphanumeric characters and
   *  underscores within it.
   */
  // const linkId = 'abc123'

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

  async function callCreateLink() {
    // Construct request
    const request = {
      parent,
      link,
      linkId,
    };

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

  callCreateLink();

(async) checkDeleteLinkProgress(name) → {Promise}

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

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 full resource name of the link to delete.
   *   "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
   *    "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
   *    "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
   *    "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
   */
  // const name = 'abc123'

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callDeleteLink();

(async) checkUpdateBucketAsyncProgress(name) → {Promise}

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

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 full resource name of the bucket to update.
   *      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *      "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *      "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *      "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   *  For example:
   *    `"projects/my-project/locations/global/buckets/my-bucket"`
   */
  // const name = 'abc123'
  /**
   *  Required. The updated bucket.
   */
  // const bucket = {}
  /**
   *  Required. Field mask that specifies the fields in `bucket` that need an
   *  update. A bucket field will be overwritten if, and only if, it is in the
   *  update mask. `name` and output only fields cannot be updated.
   *  For a detailed `FieldMask` definition, see:
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
   *  For example: `updateMask=retention_days`
   */
  // const updateMask = {}

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callUpdateBucketAsync();

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.

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: ''});
```

folderCmekSettingsPath(folder) → {string}

Return a fully-qualified folderCmekSettings resource name string.

Parameters:

Name	Type	Description
`folder`	string

Returns:

Type	Description
string	Resource name string.

folderExclusionPath(folder, exclusion) → {string}

Return a fully-qualified folderExclusion resource name string.

Parameters:

Name	Type	Description
`folder`	string
`exclusion`	string

Returns:

Type	Description
string	Resource name string.

folderLocationBucketLinkPath(folder, location, bucket, link) → {string}

Return a fully-qualified folderLocationBucketLink resource name string.

Parameters:

Name	Type	Description
`folder`	string
`location`	string
`bucket`	string
`link`	string

Returns:

Type	Description
string	Resource name string.

folderLocationBucketPath(folder, location, bucket) → {string}

Return a fully-qualified folderLocationBucket resource name string.

Parameters:

Name	Type	Description
`folder`	string
`location`	string
`bucket`	string

Returns:

Type	Description
string	Resource name string.

folderLocationBucketViewPath(folder, location, bucket, view) → {string}

Return a fully-qualified folderLocationBucketView resource name string.

Parameters:

Name	Type	Description
`folder`	string
`location`	string
`bucket`	string
`view`	string

Returns:

Type	Description
string	Resource name string.

folderLogPath(folder, log) → {string}

Return a fully-qualified folderLog resource name string.

Parameters:

Name	Type	Description
`folder`	string
`log`	string

Returns:

Type	Description
string	Resource name string.

folderSettingsPath(folder) → {string}

Return a fully-qualified folderSettings resource name string.

Parameters:

Name	Type	Description
`folder`	string

Returns:

Type	Description
string	Resource name string.

folderSinkPath(folder, sink) → {string}

Return a fully-qualified folderSink resource name string.

Parameters:

Name	Type	Description
`folder`	string
`sink`	string

Returns:

Type	Description
string	Resource name string.

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.

listBucketsAsync(request, optionsopt) → {Object}

Equivalent to listBuckets, 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 Attributes Description

parent

string

Required. The parent resource whose buckets are to be listed:

  "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
  "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]"
  "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]"
  "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

Note: The locations portion of the resource must be specified, but supplying the character - in place of [LOCATION_ID] will return all buckets.

pageToken

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

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 LogBucket. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource whose buckets are to be listed:
   *      "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
   *      "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]"
   *      "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]"
   *      "folders/[FOLDER_ID]/locations/[LOCATION_ID]"
   *  Note: The locations portion of the resource must be specified, but
   *  supplying the character `-` in place of LOCATION_ID  will return all
   *  buckets.
   */
  // const parent = 'abc123'
  /**
   *  Optional. If present, then retrieve the next batch of results from the
   *  preceding call to this method. `pageToken` must be the value of
   *  `nextPageToken` from the previous response. The values of other method
   *  parameters should be identical to those in the previous call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of results to return from this request.
   *  Non-positive values are ignored. The presence of `nextPageToken` in the
   *  response indicates that more results might be available.
   */
  // const pageSize = 1234

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callListBuckets();

listBucketsStream(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 Attributes Description

parent

string

Required. The parent resource whose buckets are to be listed:

  "projects/[PROJECT_ID]/locations/[LOCATION_ID]"
  "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]"
  "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]"
  "folders/[FOLDER_ID]/locations/[LOCATION_ID]"

Note: The locations portion of the resource must be specified, but supplying the character - in place of [LOCATION_ID] will return all buckets.

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

options

object

Call options. See CallOptions for more details.

Returns:

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

listExclusionsAsync(request, optionsopt) → {Object}

Equivalent to listExclusions, 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 Attributes Description

parent

string

Required. The parent resource whose exclusions are to be listed.

  "projects/[PROJECT_ID]"
  "organizations/[ORGANIZATION_ID]"
  "billingAccounts/[BILLING_ACCOUNT_ID]"
  "folders/[FOLDER_ID]"

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

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 LogExclusion. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource whose exclusions are to be listed.
   *      "projects/[PROJECT_ID]"
   *      "organizations/[ORGANIZATION_ID]"
   *      "billingAccounts/[BILLING_ACCOUNT_ID]"
   *      "folders/[FOLDER_ID]"
   */
  // const parent = 'abc123'
  /**
   *  Optional. If present, then retrieve the next batch of results from the
   *  preceding call to this method. `pageToken` must be the value of
   *  `nextPageToken` from the previous response. The values of other method
   *  parameters should be identical to those in the previous call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of results to return from this request.
   *  Non-positive values are ignored. The presence of `nextPageToken` in the
   *  response indicates that more results might be available.
   */
  // const pageSize = 1234

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callListExclusions();

listExclusionsStream(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 Attributes Description

parent

string

Required. The parent resource whose exclusions are to be listed.

  "projects/[PROJECT_ID]"
  "organizations/[ORGANIZATION_ID]"
  "billingAccounts/[BILLING_ACCOUNT_ID]"
  "folders/[FOLDER_ID]"

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

options

object

Call options. See CallOptions for more details.

Returns:

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

listLinksAsync(request, optionsopt) → {Object}

Equivalent to listLinks, 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 Attributes Description

parent

string

Required. The parent resource whose links are to be listed:

"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/

pageToken

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response.

pageSize

number

Optional. The maximum number of results to return from this request.

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 Link. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource whose links are to be listed:
   *    "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/"
   *    "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
   *    "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
   *    "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/
   */
  // const parent = 'abc123'
  /**
   *  Optional. If present, then retrieve the next batch of results from the
   *  preceding call to this method. `pageToken` must be the value of
   *  `nextPageToken` from the previous response.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of results to return from this request.
   */
  // const pageSize = 1234

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callListLinks();

listLinksStream(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 Attributes Description

parent

string

Required. The parent resource whose links are to be listed:

"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
"billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/"
"folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/

pageToken

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response.

pageSize

number

Optional. The maximum number of results to return from this request.

options

object

Call options. See CallOptions for more details.

Returns:

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

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)
```

listSinksAsync(request, optionsopt) → {Object}

Equivalent to listSinks, 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 Attributes Description

parent

string

Required. The parent resource whose sinks are to be listed:

  "projects/[PROJECT_ID]"
  "organizations/[ORGANIZATION_ID]"
  "billingAccounts/[BILLING_ACCOUNT_ID]"
  "folders/[FOLDER_ID]"

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

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 LogSink. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource whose sinks are to be listed:
   *      "projects/[PROJECT_ID]"
   *      "organizations/[ORGANIZATION_ID]"
   *      "billingAccounts/[BILLING_ACCOUNT_ID]"
   *      "folders/[FOLDER_ID]"
   */
  // const parent = 'abc123'
  /**
   *  Optional. If present, then retrieve the next batch of results from the
   *  preceding call to this method. `pageToken` must be the value of
   *  `nextPageToken` from the previous response. The values of other method
   *  parameters should be identical to those in the previous call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of results to return from this request.
   *  Non-positive values are ignored. The presence of `nextPageToken` in the
   *  response indicates that more results might be available.
   */
  // const pageSize = 1234

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callListSinks();

listSinksStream(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 Attributes Description

parent

string

Required. The parent resource whose sinks are to be listed:

  "projects/[PROJECT_ID]"
  "organizations/[ORGANIZATION_ID]"
  "billingAccounts/[BILLING_ACCOUNT_ID]"
  "folders/[FOLDER_ID]"

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

options

object

Call options. See CallOptions for more details.

Returns:

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

listViewsAsync(request, optionsopt) → {Object}

Equivalent to listViews, 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 Attributes Description

parent

string

Required. The bucket whose views are to be listed:

  "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

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 LogView. 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 bucket whose views are to be listed:
   *      "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
   */
  // const parent = 'abc123'
  /**
   *  Optional. If present, then retrieve the next batch of results from the
   *  preceding call to this method. `pageToken` must be the value of
   *  `nextPageToken` from the previous response. The values of other method
   *  parameters should be identical to those in the previous call.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of results to return from this request.
   *  Non-positive values are ignored. The presence of `nextPageToken` in the
   *  response indicates that more results might be available.
   */
  // const pageSize = 1234

  // Imports the Logging library
  const {ConfigServiceV2Client} = require('@google-cloud/logging').v2;

  // Instantiates a client
  const loggingClient = new ConfigServiceV2Client();

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

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

  callListViews();

listViewsStream(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 Attributes Description

parent

string

Required. The bucket whose views are to be listed:

  "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

pageToken

string

pageSize

number

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.

options

object

Call options. See CallOptions for more details.

Returns:

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

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.

logMetricPath(project, metric) → {string}

Return a fully-qualified logMetric resource name string.

Parameters:

Name	Type	Description
`project`	string
`metric`	string

Returns:

Type	Description
string	Resource name string.

matchBillingAccountFromBillingAccountCmekSettingsName(billingAccountCmekSettingsName) → {string}

Parse the billing_account from BillingAccountCmekSettings resource.

Parameters:

Name	Type	Description
`billingAccountCmekSettingsName`	string	A fully-qualified path representing billing_account_cmekSettings resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountExclusionName(billingAccountExclusionName) → {string}

Parse the billing_account from BillingAccountExclusion resource.

Parameters:

Name	Type	Description
`billingAccountExclusionName`	string	A fully-qualified path representing billing_account_exclusion resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationBucketLinkName(billingAccountLocationBucketLinkName) → {string}

Parse the billing_account from BillingAccountLocationBucketLink resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketLinkName`	string	A fully-qualified path representing billing_account_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationBucketName(billingAccountLocationBucketName) → {string}

Parse the billing_account from BillingAccountLocationBucket resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketName`	string	A fully-qualified path representing billing_account_location_bucket resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationBucketViewName(billingAccountLocationBucketViewName) → {string}

Parse the billing_account from BillingAccountLocationBucketView resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketViewName`	string	A fully-qualified path representing billing_account_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountLogName(billingAccountLogName) → {string}

Parse the billing_account from BillingAccountLog resource.

Parameters:

Name	Type	Description
`billingAccountLogName`	string	A fully-qualified path representing billing_account_log resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountSettingsName(billingAccountSettingsName) → {string}

Parse the billing_account from BillingAccountSettings resource.

Parameters:

Name	Type	Description
`billingAccountSettingsName`	string	A fully-qualified path representing billing_account_settings resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBillingAccountFromBillingAccountSinkName(billingAccountSinkName) → {string}

Parse the billing_account from BillingAccountSink resource.

Parameters:

Name	Type	Description
`billingAccountSinkName`	string	A fully-qualified path representing billing_account_sink resource.

Returns:

Type	Description
string	A string representing the billing_account.

matchBucketFromBillingAccountLocationBucketLinkName(billingAccountLocationBucketLinkName) → {string}

Parse the bucket from BillingAccountLocationBucketLink resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketLinkName`	string	A fully-qualified path representing billing_account_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromBillingAccountLocationBucketName(billingAccountLocationBucketName) → {string}

Parse the bucket from BillingAccountLocationBucket resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketName`	string	A fully-qualified path representing billing_account_location_bucket resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromBillingAccountLocationBucketViewName(billingAccountLocationBucketViewName) → {string}

Parse the bucket from BillingAccountLocationBucketView resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketViewName`	string	A fully-qualified path representing billing_account_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromFolderLocationBucketLinkName(folderLocationBucketLinkName) → {string}

Parse the bucket from FolderLocationBucketLink resource.

Parameters:

Name	Type	Description
`folderLocationBucketLinkName`	string	A fully-qualified path representing folder_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromFolderLocationBucketName(folderLocationBucketName) → {string}

Parse the bucket from FolderLocationBucket resource.

Parameters:

Name	Type	Description
`folderLocationBucketName`	string	A fully-qualified path representing folder_location_bucket resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromFolderLocationBucketViewName(folderLocationBucketViewName) → {string}

Parse the bucket from FolderLocationBucketView resource.

Parameters:

Name	Type	Description
`folderLocationBucketViewName`	string	A fully-qualified path representing folder_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromOrganizationLocationBucketLinkName(organizationLocationBucketLinkName) → {string}

Parse the bucket from OrganizationLocationBucketLink resource.

Parameters:

Name	Type	Description
`organizationLocationBucketLinkName`	string	A fully-qualified path representing organization_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromOrganizationLocationBucketName(organizationLocationBucketName) → {string}

Parse the bucket from OrganizationLocationBucket resource.

Parameters:

Name	Type	Description
`organizationLocationBucketName`	string	A fully-qualified path representing organization_location_bucket resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromOrganizationLocationBucketViewName(organizationLocationBucketViewName) → {string}

Parse the bucket from OrganizationLocationBucketView resource.

Parameters:

Name	Type	Description
`organizationLocationBucketViewName`	string	A fully-qualified path representing organization_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromProjectLocationBucketLinkName(projectLocationBucketLinkName) → {string}

Parse the bucket from ProjectLocationBucketLink resource.

Parameters:

Name	Type	Description
`projectLocationBucketLinkName`	string	A fully-qualified path representing project_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromProjectLocationBucketName(projectLocationBucketName) → {string}

Parse the bucket from ProjectLocationBucket resource.

Parameters:

Name	Type	Description
`projectLocationBucketName`	string	A fully-qualified path representing project_location_bucket resource.

Returns:

Type	Description
string	A string representing the bucket.

matchBucketFromProjectLocationBucketViewName(projectLocationBucketViewName) → {string}

Parse the bucket from ProjectLocationBucketView resource.

Parameters:

Name	Type	Description
`projectLocationBucketViewName`	string	A fully-qualified path representing project_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the bucket.

matchExclusionFromBillingAccountExclusionName(billingAccountExclusionName) → {string}

Parse the exclusion from BillingAccountExclusion resource.

Parameters:

Name	Type	Description
`billingAccountExclusionName`	string	A fully-qualified path representing billing_account_exclusion resource.

Returns:

Type	Description
string	A string representing the exclusion.

matchExclusionFromFolderExclusionName(folderExclusionName) → {string}

Parse the exclusion from FolderExclusion resource.

Parameters:

Name	Type	Description
`folderExclusionName`	string	A fully-qualified path representing folder_exclusion resource.

Returns:

Type	Description
string	A string representing the exclusion.

matchExclusionFromOrganizationExclusionName(organizationExclusionName) → {string}

Parse the exclusion from OrganizationExclusion resource.

Parameters:

Name	Type	Description
`organizationExclusionName`	string	A fully-qualified path representing organization_exclusion resource.

Returns:

Type	Description
string	A string representing the exclusion.

matchExclusionFromProjectExclusionName(projectExclusionName) → {string}

Parse the exclusion from ProjectExclusion resource.

Parameters:

Name	Type	Description
`projectExclusionName`	string	A fully-qualified path representing project_exclusion resource.

Returns:

Type	Description
string	A string representing the exclusion.

matchFolderFromFolderCmekSettingsName(folderCmekSettingsName) → {string}

Parse the folder from FolderCmekSettings resource.

Parameters:

Name	Type	Description
`folderCmekSettingsName`	string	A fully-qualified path representing folder_cmekSettings resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderExclusionName(folderExclusionName) → {string}

Parse the folder from FolderExclusion resource.

Parameters:

Name	Type	Description
`folderExclusionName`	string	A fully-qualified path representing folder_exclusion resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderLocationBucketLinkName(folderLocationBucketLinkName) → {string}

Parse the folder from FolderLocationBucketLink resource.

Parameters:

Name	Type	Description
`folderLocationBucketLinkName`	string	A fully-qualified path representing folder_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderLocationBucketName(folderLocationBucketName) → {string}

Parse the folder from FolderLocationBucket resource.

Parameters:

Name	Type	Description
`folderLocationBucketName`	string	A fully-qualified path representing folder_location_bucket resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderLocationBucketViewName(folderLocationBucketViewName) → {string}

Parse the folder from FolderLocationBucketView resource.

Parameters:

Name	Type	Description
`folderLocationBucketViewName`	string	A fully-qualified path representing folder_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderLogName(folderLogName) → {string}

Parse the folder from FolderLog resource.

Parameters:

Name	Type	Description
`folderLogName`	string	A fully-qualified path representing folder_log resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderSettingsName(folderSettingsName) → {string}

Parse the folder from FolderSettings resource.

Parameters:

Name	Type	Description
`folderSettingsName`	string	A fully-qualified path representing folder_settings resource.

Returns:

Type	Description
string	A string representing the folder.

matchFolderFromFolderSinkName(folderSinkName) → {string}

Parse the folder from FolderSink resource.

Parameters:

Name	Type	Description
`folderSinkName`	string	A fully-qualified path representing folder_sink resource.

Returns:

Type	Description
string	A string representing the folder.

matchLinkFromBillingAccountLocationBucketLinkName(billingAccountLocationBucketLinkName) → {string}

Parse the link from BillingAccountLocationBucketLink resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketLinkName`	string	A fully-qualified path representing billing_account_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the link.

matchLinkFromFolderLocationBucketLinkName(folderLocationBucketLinkName) → {string}

Parse the link from FolderLocationBucketLink resource.

Parameters:

Name	Type	Description
`folderLocationBucketLinkName`	string	A fully-qualified path representing folder_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the link.

matchLinkFromOrganizationLocationBucketLinkName(organizationLocationBucketLinkName) → {string}

Parse the link from OrganizationLocationBucketLink resource.

Parameters:

Name	Type	Description
`organizationLocationBucketLinkName`	string	A fully-qualified path representing organization_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the link.

matchLinkFromProjectLocationBucketLinkName(projectLocationBucketLinkName) → {string}

Parse the link from ProjectLocationBucketLink resource.

Parameters:

Name	Type	Description
`projectLocationBucketLinkName`	string	A fully-qualified path representing project_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the link.

matchLocationFromBillingAccountLocationBucketLinkName(billingAccountLocationBucketLinkName) → {string}

Parse the location from BillingAccountLocationBucketLink resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketLinkName`	string	A fully-qualified path representing billing_account_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromBillingAccountLocationBucketName(billingAccountLocationBucketName) → {string}

Parse the location from BillingAccountLocationBucket resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketName`	string	A fully-qualified path representing billing_account_location_bucket resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromBillingAccountLocationBucketViewName(billingAccountLocationBucketViewName) → {string}

Parse the location from BillingAccountLocationBucketView resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketViewName`	string	A fully-qualified path representing billing_account_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFolderLocationBucketLinkName(folderLocationBucketLinkName) → {string}

Parse the location from FolderLocationBucketLink resource.

Parameters:

Name	Type	Description
`folderLocationBucketLinkName`	string	A fully-qualified path representing folder_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFolderLocationBucketName(folderLocationBucketName) → {string}

Parse the location from FolderLocationBucket resource.

Parameters:

Name	Type	Description
`folderLocationBucketName`	string	A fully-qualified path representing folder_location_bucket resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromFolderLocationBucketViewName(folderLocationBucketViewName) → {string}

Parse the location from FolderLocationBucketView resource.

Parameters:

Name	Type	Description
`folderLocationBucketViewName`	string	A fully-qualified path representing folder_location_bucket_view 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.

matchLocationFromOrganizationLocationBucketLinkName(organizationLocationBucketLinkName) → {string}

Parse the location from OrganizationLocationBucketLink resource.

Parameters:

Name	Type	Description
`organizationLocationBucketLinkName`	string	A fully-qualified path representing organization_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromOrganizationLocationBucketName(organizationLocationBucketName) → {string}

Parse the location from OrganizationLocationBucket resource.

Parameters:

Name	Type	Description
`organizationLocationBucketName`	string	A fully-qualified path representing organization_location_bucket resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromOrganizationLocationBucketViewName(organizationLocationBucketViewName) → {string}

Parse the location from OrganizationLocationBucketView resource.

Parameters:

Name	Type	Description
`organizationLocationBucketViewName`	string	A fully-qualified path representing organization_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationBucketLinkName(projectLocationBucketLinkName) → {string}

Parse the location from ProjectLocationBucketLink resource.

Parameters:

Name	Type	Description
`projectLocationBucketLinkName`	string	A fully-qualified path representing project_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationBucketName(projectLocationBucketName) → {string}

Parse the location from ProjectLocationBucket resource.

Parameters:

Name	Type	Description
`projectLocationBucketName`	string	A fully-qualified path representing project_location_bucket resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationBucketViewName(projectLocationBucketViewName) → {string}

Parse the location from ProjectLocationBucketView resource.

Parameters:

Name	Type	Description
`projectLocationBucketViewName`	string	A fully-qualified path representing project_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the location.

matchLogFromBillingAccountLogName(billingAccountLogName) → {string}

Parse the log from BillingAccountLog resource.

Parameters:

Name	Type	Description
`billingAccountLogName`	string	A fully-qualified path representing billing_account_log resource.

Returns:

Type	Description
string	A string representing the log.

matchLogFromFolderLogName(folderLogName) → {string}

Parse the log from FolderLog resource.

Parameters:

Name	Type	Description
`folderLogName`	string	A fully-qualified path representing folder_log resource.

Returns:

Type	Description
string	A string representing the log.

matchLogFromOrganizationLogName(organizationLogName) → {string}

Parse the log from OrganizationLog resource.

Parameters:

Name	Type	Description
`organizationLogName`	string	A fully-qualified path representing organization_log resource.

Returns:

Type	Description
string	A string representing the log.

matchLogFromProjectLogName(projectLogName) → {string}

Parse the log from ProjectLog resource.

Parameters:

Name	Type	Description
`projectLogName`	string	A fully-qualified path representing project_log resource.

Returns:

Type	Description
string	A string representing the log.

matchMetricFromLogMetricName(logMetricName) → {string}

Parse the metric from LogMetric resource.

Parameters:

Name	Type	Description
`logMetricName`	string	A fully-qualified path representing LogMetric resource.

Returns:

Type	Description
string	A string representing the metric.

matchOrganizationFromOrganizationCmekSettingsName(organizationCmekSettingsName) → {string}

Parse the organization from OrganizationCmekSettings resource.

Parameters:

Name	Type	Description
`organizationCmekSettingsName`	string	A fully-qualified path representing organization_cmekSettings resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationExclusionName(organizationExclusionName) → {string}

Parse the organization from OrganizationExclusion resource.

Parameters:

Name	Type	Description
`organizationExclusionName`	string	A fully-qualified path representing organization_exclusion resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationLocationBucketLinkName(organizationLocationBucketLinkName) → {string}

Parse the organization from OrganizationLocationBucketLink resource.

Parameters:

Name	Type	Description
`organizationLocationBucketLinkName`	string	A fully-qualified path representing organization_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationLocationBucketName(organizationLocationBucketName) → {string}

Parse the organization from OrganizationLocationBucket resource.

Parameters:

Name	Type	Description
`organizationLocationBucketName`	string	A fully-qualified path representing organization_location_bucket resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationLocationBucketViewName(organizationLocationBucketViewName) → {string}

Parse the organization from OrganizationLocationBucketView resource.

Parameters:

Name	Type	Description
`organizationLocationBucketViewName`	string	A fully-qualified path representing organization_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationLogName(organizationLogName) → {string}

Parse the organization from OrganizationLog resource.

Parameters:

Name	Type	Description
`organizationLogName`	string	A fully-qualified path representing organization_log resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationSettingsName(organizationSettingsName) → {string}

Parse the organization from OrganizationSettings resource.

Parameters:

Name	Type	Description
`organizationSettingsName`	string	A fully-qualified path representing organization_settings resource.

Returns:

Type	Description
string	A string representing the organization.

matchOrganizationFromOrganizationSinkName(organizationSinkName) → {string}

Parse the organization from OrganizationSink resource.

Parameters:

Name	Type	Description
`organizationSinkName`	string	A fully-qualified path representing organization_sink resource.

Returns:

Type	Description
string	A string representing the organization.

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.

matchProjectFromLogMetricName(logMetricName) → {string}

Parse the project from LogMetric resource.

Parameters:

Name	Type	Description
`logMetricName`	string	A fully-qualified path representing LogMetric resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectCmekSettingsName(projectCmekSettingsName) → {string}

Parse the project from ProjectCmekSettings resource.

Parameters:

Name	Type	Description
`projectCmekSettingsName`	string	A fully-qualified path representing project_cmekSettings resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectExclusionName(projectExclusionName) → {string}

Parse the project from ProjectExclusion resource.

Parameters:

Name	Type	Description
`projectExclusionName`	string	A fully-qualified path representing project_exclusion resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationBucketLinkName(projectLocationBucketLinkName) → {string}

Parse the project from ProjectLocationBucketLink resource.

Parameters:

Name	Type	Description
`projectLocationBucketLinkName`	string	A fully-qualified path representing project_location_bucket_link resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationBucketName(projectLocationBucketName) → {string}

Parse the project from ProjectLocationBucket resource.

Parameters:

Name	Type	Description
`projectLocationBucketName`	string	A fully-qualified path representing project_location_bucket resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationBucketViewName(projectLocationBucketViewName) → {string}

Parse the project from ProjectLocationBucketView resource.

Parameters:

Name	Type	Description
`projectLocationBucketViewName`	string	A fully-qualified path representing project_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLogName(projectLogName) → {string}

Parse the project from ProjectLog resource.

Parameters:

Name	Type	Description
`projectLogName`	string	A fully-qualified path representing project_log 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.

matchProjectFromProjectSettingsName(projectSettingsName) → {string}

Parse the project from ProjectSettings resource.

Parameters:

Name	Type	Description
`projectSettingsName`	string	A fully-qualified path representing project_settings resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectSinkName(projectSinkName) → {string}

Parse the project from ProjectSink resource.

Parameters:

Name	Type	Description
`projectSinkName`	string	A fully-qualified path representing project_sink resource.

Returns:

Type	Description
string	A string representing the project.

matchSinkFromBillingAccountSinkName(billingAccountSinkName) → {string}

Parse the sink from BillingAccountSink resource.

Parameters:

Name	Type	Description
`billingAccountSinkName`	string	A fully-qualified path representing billing_account_sink resource.

Returns:

Type	Description
string	A string representing the sink.

matchSinkFromFolderSinkName(folderSinkName) → {string}

Parse the sink from FolderSink resource.

Parameters:

Name	Type	Description
`folderSinkName`	string	A fully-qualified path representing folder_sink resource.

Returns:

Type	Description
string	A string representing the sink.

matchSinkFromOrganizationSinkName(organizationSinkName) → {string}

Parse the sink from OrganizationSink resource.

Parameters:

Name	Type	Description
`organizationSinkName`	string	A fully-qualified path representing organization_sink resource.

Returns:

Type	Description
string	A string representing the sink.

matchSinkFromProjectSinkName(projectSinkName) → {string}

Parse the sink from ProjectSink resource.

Parameters:

Name	Type	Description
`projectSinkName`	string	A fully-qualified path representing project_sink resource.

Returns:

Type	Description
string	A string representing the sink.

matchViewFromBillingAccountLocationBucketViewName(billingAccountLocationBucketViewName) → {string}

Parse the view from BillingAccountLocationBucketView resource.

Parameters:

Name	Type	Description
`billingAccountLocationBucketViewName`	string	A fully-qualified path representing billing_account_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the view.

matchViewFromFolderLocationBucketViewName(folderLocationBucketViewName) → {string}

Parse the view from FolderLocationBucketView resource.

Parameters:

Name	Type	Description
`folderLocationBucketViewName`	string	A fully-qualified path representing folder_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the view.

matchViewFromOrganizationLocationBucketViewName(organizationLocationBucketViewName) → {string}

Parse the view from OrganizationLocationBucketView resource.

Parameters:

Name	Type	Description
`organizationLocationBucketViewName`	string	A fully-qualified path representing organization_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the view.

matchViewFromProjectLocationBucketViewName(projectLocationBucketViewName) → {string}

Parse the view from ProjectLocationBucketView resource.

Parameters:

Name	Type	Description
`projectLocationBucketViewName`	string	A fully-qualified path representing project_location_bucket_view resource.

Returns:

Type	Description
string	A string representing the view.

organizationCmekSettingsPath(organization) → {string}

Return a fully-qualified organizationCmekSettings resource name string.

Parameters:

Name	Type	Description
`organization`	string

Returns:

Type	Description
string	Resource name string.

organizationExclusionPath(organization, exclusion) → {string}

Return a fully-qualified organizationExclusion resource name string.

Parameters:

Name	Type	Description
`organization`	string
`exclusion`	string

Returns:

Type	Description
string	Resource name string.

organizationLocationBucketLinkPath(organization, location, bucket, link) → {string}

Return a fully-qualified organizationLocationBucketLink resource name string.

Parameters:

Name	Type	Description
`organization`	string
`location`	string
`bucket`	string
`link`	string

Returns:

Type	Description
string	Resource name string.

organizationLocationBucketPath(organization, location, bucket) → {string}

Return a fully-qualified organizationLocationBucket resource name string.

Parameters:

Name	Type	Description
`organization`	string
`location`	string
`bucket`	string

Returns:

Type	Description
string	Resource name string.

organizationLocationBucketViewPath(organization, location, bucket, view) → {string}

Return a fully-qualified organizationLocationBucketView resource name string.

Parameters:

Name	Type	Description
`organization`	string
`location`	string
`bucket`	string
`view`	string

Returns:

Type	Description
string	Resource name string.

organizationLogPath(organization, log) → {string}

Return a fully-qualified organizationLog resource name string.

Parameters:

Name	Type	Description
`organization`	string
`log`	string

Returns:

Type	Description
string	Resource name string.

organizationSettingsPath(organization) → {string}

Return a fully-qualified organizationSettings resource name string.

Parameters:

Name	Type	Description
`organization`	string

Returns:

Type	Description
string	Resource name string.

organizationSinkPath(organization, sink) → {string}

Return a fully-qualified organizationSink resource name string.

Parameters:

Name	Type	Description
`organization`	string
`sink`	string

Returns:

Type	Description
string	Resource name string.

projectCmekSettingsPath(project) → {string}

Return a fully-qualified projectCmekSettings resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectExclusionPath(project, exclusion) → {string}

Return a fully-qualified projectExclusion resource name string.

Parameters:

Name	Type	Description
`project`	string
`exclusion`	string

Returns:

Type	Description
string	Resource name string.

projectLocationBucketLinkPath(project, location, bucket, link) → {string}

Return a fully-qualified projectLocationBucketLink resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`bucket`	string
`link`	string

Returns:

Type	Description
string	Resource name string.

projectLocationBucketPath(project, location, bucket) → {string}

Return a fully-qualified projectLocationBucket resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`bucket`	string

Returns:

Type	Description
string	Resource name string.

projectLocationBucketViewPath(project, location, bucket, view) → {string}

Return a fully-qualified projectLocationBucketView resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`bucket`	string
`view`	string

Returns:

Type	Description
string	Resource name string.

projectLogPath(project, log) → {string}

Return a fully-qualified projectLog resource name string.

Parameters:

Name	Type	Description
`project`	string
`log`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectSettingsPath(project) → {string}

Return a fully-qualified projectSettings resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectSinkPath(project, sink) → {string}

Return a fully-qualified projectSink resource name string.

Parameters:

Name	Type	Description
`project`	string
`sink`	string

Returns:

Type	Description
string	Resource name string.