Constructor
new LoggingServiceV2Client(optionsopt, gaxInstanceopt)
Construct an instance of LoggingServiceV2Client.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
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. |
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. |
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. |
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. |
listLogEntriesAsync(request, optionsopt) → {Object}
Equivalent to listLogEntries, 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
|
|||||||||||||||||||||||||
options |
object |
<optional> |
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 LogEntry. 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. Names of one or more parent resources from which to
* retrieve log entries:
* * `projects/[PROJECT_ID]`
* * `organizations/[ORGANIZATION_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]`
* * `folders/[FOLDER_ID]`
* May alternatively be one or more views:
* * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* Projects listed in the `project_ids` field are added to this list.
* A maximum of 100 resources may be specified in a single request.
*/
// const resourceNames = 'abc123'
/**
* Optional. Only log entries that match the filter are returned. An empty
* filter matches all log entries in the resources listed in `resource_names`.
* Referencing a parent resource that is not listed in `resource_names` will
* cause the filter to return no results. The maximum length of a filter is
* 20,000 characters.
*/
// const filter = 'abc123'
/**
* Optional. How the results should be sorted. Presently, the only permitted
* values are `"timestamp asc"` (default) and `"timestamp desc"`. The first
* option returns entries in order of increasing values of
* `LogEntry.timestamp` (oldest first), and the second option returns entries
* in order of decreasing timestamps (newest first). Entries with equal
* timestamps are returned in order of their `insert_id` values.
*/
// const orderBy = 'abc123'
/**
* Optional. The maximum number of results to return from this request.
* Default is 50. If the value is negative or exceeds 1000, the request is
* rejected. The presence of `next_page_token` in the response indicates that
* more results might be available.
*/
// const pageSize = 1234
/**
* Optional. If present, then retrieve the next batch of results from the
* preceding call to this method. `page_token` must be the value of
* `next_page_token` from the previous response. The values of other method
* parameters should be identical to those in the previous call.
*/
// const pageToken = 'abc123'
// Imports the Logging library
const {LoggingServiceV2Client} = require('@google-cloud/logging').v2;
// Instantiates a client
const loggingClient = new LoggingServiceV2Client();
async function callListLogEntries() {
// Construct request
const request = {
resourceNames,
};
// Run request
const iterable = await loggingClient.listLogEntriesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListLogEntries();
listLogEntriesStream(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
|
|||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which emits an object representing LogEntry 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 |
listLogsAsync(request, optionsopt) → {Object}
Equivalent to listLogs, 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
|
|||||||||||||||||||||
options |
object |
<optional> |
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 string. 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 resource name to list logs for:
* * `projects/[PROJECT_ID]`
* * `organizations/[ORGANIZATION_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]`
* * `folders/[FOLDER_ID]`
*/
// const parent = 'abc123'
/**
* Optional. List of resource names to list logs for:
* * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* To support legacy queries, it could also be:
* * `projects/[PROJECT_ID]`
* * `organizations/[ORGANIZATION_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]`
* * `folders/[FOLDER_ID]`
* The resource name in the `parent` field is added to this list.
*/
// const resourceNames = '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
/**
* 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'
// Imports the Logging library
const {LoggingServiceV2Client} = require('@google-cloud/logging').v2;
// Instantiates a client
const loggingClient = new LoggingServiceV2Client();
async function callListLogs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await loggingClient.listLogsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListLogs();
listLogsStream(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
|
|||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which emits an object representing string 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 |
listMonitoredResourceDescriptorsAsync(request, optionsopt) → {Object}
Equivalent to listMonitoredResourceDescriptors, 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
|
|||||||||||||
options |
object |
<optional> |
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 MonitoredResourceDescriptor. 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.
*/
/**
* 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
/**
* 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'
// Imports the Logging library
const {LoggingServiceV2Client} = require('@google-cloud/logging').v2;
// Instantiates a client
const loggingClient = new LoggingServiceV2Client();
async function callListMonitoredResourceDescriptors() {
// Construct request
const request = {};
// Run request
const iterable = await loggingClient.listMonitoredResourceDescriptorsAsync(
request
);
for await (const response of iterable) {
console.log(response);
}
}
callListMonitoredResourceDescriptors();
listMonitoredResourceDescriptorsStream(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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which emits an object representing MonitoredResourceDescriptor 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 |
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. |
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. |
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. |
tailLogEntries(optionsopt) → {Stream}
Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which is both readable and writable. It accepts objects representing TailLogEntriesRequest for write() method, and will emit objects representing TailLogEntriesResponse on 'data' event asynchronously. 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. Name of a parent resource from which to retrieve log entries:
* * `projects/[PROJECT_ID]`
* * `organizations/[ORGANIZATION_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]`
* * `folders/[FOLDER_ID]`
* May alternatively be one or more views:
* * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
* * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
*/
// const resourceNames = 'abc123'
/**
* Optional. Only log entries that match the filter are returned. An empty
* filter matches all log entries in the resources listed in `resource_names`.
* Referencing a parent resource that is not listed in `resource_names` will
* cause the filter to return no results. The maximum length of a filter is
* 20,000 characters.
*/
// const filter = 'abc123'
/**
* Optional. The amount of time to buffer log entries at the server before
* being returned to prevent out of order results due to late arriving log
* entries. Valid values are between 0-60000 milliseconds. Defaults to 2000
* milliseconds.
*/
// const bufferWindow = {}
// Imports the Logging library
const {LoggingServiceV2Client} = require('@google-cloud/logging').v2;
// Instantiates a client
const loggingClient = new LoggingServiceV2Client();
async function callTailLogEntries() {
// Construct request
const request = {
resourceNames,
};
// Run request
const stream = await loggingClient.tailLogEntries();
stream.on('data', response => {
console.log(response);
});
stream.on('error', err => {
throw err;
});
stream.on('end', () => {
/* API call completed */
});
stream.write(request);
stream.end();
}
callTailLogEntries();