Constructor
new ConfigServiceV2Client(optionsopt)
Construct an instance of ConfigServiceV2Client.
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
|
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. |
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. |
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. |
createBucket(request, optionsopt) → {Promise}
Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.
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 |
---|---|
Promise |
|
createExclusion(request, optionsopt) → {Promise}
Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.
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 |
---|---|
Promise |
|
createSink(request, optionsopt) → {Promise}
Creates a sink that exports specified log entries to a destination. The
export of newly-ingested log entries begins immediately, unless the sink's
writer_identity
is not permitted to write to the destination. A sink can
export log entries only from the resource owning the sink.
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 |
---|---|
Promise |
|
createView(request, optionsopt) → {Promise}
Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.
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 |
---|---|
Promise |
|
deleteBucket(request, optionsopt) → {Promise}
Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted.
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 |
---|---|
Promise |
|
deleteExclusion(request, optionsopt) → {Promise}
Deletes an exclusion.
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 |
---|---|
Promise |
|
deleteSink(request, optionsopt) → {Promise}
Deletes a sink. If the sink has a unique writer_identity
, then that
service account is also deleted.
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 |
---|---|
Promise |
|
deleteView(request, optionsopt) → {Promise}
Deletes a view from a bucket.
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 |
---|---|
Promise |
|
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. |
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. |
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. |
getBucket(request, optionsopt) → {Promise}
Gets a bucket.
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 |
---|---|
Promise |
|
getCmekSettings(request, optionsopt) → {Promise}
Gets the Logs Router CMEK settings for the given resource.
Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.
See Enabling CMEK for Logs Router for more information.
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 |
---|---|
Promise |
|
getExclusion(request, optionsopt) → {Promise}
Gets the description of an exclusion.
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 |
---|---|
Promise |
|
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
getSink(request, optionsopt) → {Promise}
Gets a sink.
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 |
---|---|
Promise |
|
getView(request, optionsopt) → {Promise}
Gets a view.
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 |
---|---|
Promise |
|
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. |
listBuckets(request, optionsopt) → {Promise}
Lists buckets.
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 |
---|---|
Promise |
|
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
|
|||||||||||||||||
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 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
const iterable = client.listBucketsAsync(request);
for await (const response of iterable) {
// process response
}
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
|
|||||||||||||||||
options |
object |
<optional> |
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 |
listExclusions(request, optionsopt) → {Promise}
Lists all the exclusions in a parent resource.
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 |
---|---|
Promise |
|
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
|
|||||||||||||||||
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 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
const iterable = client.listExclusionsAsync(request);
for await (const response of iterable) {
// process response
}
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
|
|||||||||||||||||
options |
object |
<optional> |
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 |
listSinks(request, optionsopt) → {Promise}
Lists sinks.
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 |
---|---|
Promise |
|
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
|
|||||||||||||||||
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 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
const iterable = client.listSinksAsync(request);
for await (const response of iterable) {
// process response
}
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
|
|||||||||||||||||
options |
object |
<optional> |
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 |
listViews(request, optionsopt) → {Promise}
Lists views on a bucket.
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 |
---|---|
Promise |
|
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
|
|||||||||||||||||
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 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
const iterable = client.listViewsAsync(request);
for await (const response of iterable) {
// process response
}
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
|
|||||||||||||||||
options |
object |
<optional> |
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 |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
undeleteBucket(request, optionsopt) → {Promise}
Undeletes a bucket. A bucket that has been deleted may be undeleted within the grace period of 7 days.
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 |
---|---|
Promise |
|
updateBucket(request, optionsopt) → {Promise}
Updates a bucket. This method replaces the following fields in the
existing bucket with values from the new bucket: retention_period
If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.
If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.
A buckets region may not be modified after it is created.
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 |
---|---|
Promise |
|
updateCmekSettings(request, optionsopt) → {Promise}
Updates the Logs Router CMEK settings for the given resource.
Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.
UpdateCmekSettings
will fail if 1) kms_key_name
is invalid, or 2) the associated service
account does not have the required
roles/cloudkms.cryptoKeyEncrypterDecrypter
role assigned for the key, or
3) access to the key is disabled.
See Enabling CMEK for Logs Router for more information.
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 |
---|---|
Promise |
|
updateExclusion(request, optionsopt) → {Promise}
Changes one or more properties of an existing exclusion.
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 |
---|---|
Promise |
|
updateSink(request, optionsopt) → {Promise}
Updates a sink. This method replaces the following fields in the existing
sink with values from the new sink: destination
, and filter
.
The updated sink might also have a new writer_identity
; see the
unique_writer_identity
field.
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 |
---|---|
Promise |
|
updateView(request, optionsopt) → {Promise}
Updates a view. This method replaces the following fields in the existing
view with values from the new view: filter
.
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 |
---|---|
Promise |
|