googleapis
Version:
Google APIs Client Library for Node.js
911 lines • 1.41 MB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace logging_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Logging API
*
* Writes log entries and manages your Cloud Logging configuration.
*
* @example
* ```js
* const {google} = require('googleapis');
* const logging = google.logging('v2');
* ```
*/
export class Logging {
context: APIRequestContext;
billingAccounts: Resource$Billingaccounts;
entries: Resource$Entries;
exclusions: Resource$Exclusions;
folders: Resource$Folders;
locations: Resource$Locations;
logs: Resource$Logs;
monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors;
organizations: Resource$Organizations;
projects: Resource$Projects;
sinks: Resource$Sinks;
v2: Resource$V2;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Metadata associated with App Hub.
*/
export interface Schema$AppHub {
/**
* Metadata associated with the application.
*/
application?: Schema$AppHubApplication;
/**
* Metadata associated with the service.
*/
service?: Schema$AppHubService;
/**
* Metadata associated with the workload.
*/
workload?: Schema$AppHubWorkload;
}
/**
* Resource identifiers associated with an AppHub application AppHub resources are of the form projects//locations//applications/ projects//locations//applications//services/ projects//locations//applications//workloads/ These resources can be reconstructed from the components below.
*/
export interface Schema$AppHubApplication {
/**
* Resource container that owns the application. Example: "projects/management_project"
*/
container?: string | null;
/**
* Application Id. Example: "my-app"
*/
id?: string | null;
/**
* Location associated with the Application. Example: "us-east1"
*/
location?: string | null;
}
/**
* Metadata associated with an App Hub service.
*/
export interface Schema$AppHubService {
/**
* Service criticality type Example: "CRITICAL"
*/
criticalityType?: string | null;
/**
* Service environment type Example: "DEV"
*/
environmentType?: string | null;
/**
* Service Id. Example: "my-service"
*/
id?: string | null;
}
/**
* Metadata associated with an App Hub workload.
*/
export interface Schema$AppHubWorkload {
/**
* Workload criticality type Example: "CRITICAL"
*/
criticalityType?: string | null;
/**
* Workload environment type Example: "DEV"
*/
environmentType?: string | null;
/**
* Workload Id. Example: "my-workload"
*/
id?: string | null;
}
/**
* Describes a BigQuery dataset that was created by a link.
*/
export interface Schema$BigQueryDataset {
/**
* Output only. The full resource name of the BigQuery dataset. The DATASET_ID will match the ID of the link, so the link must match the naming restrictions of BigQuery datasets (alphanumeric characters and underscores only).The dataset will have a resource path of "bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID"
*/
datasetId?: string | null;
}
/**
* Options that change functionality of a sink exporting data to BigQuery.
*/
export interface Schema$BigQueryOptions {
/**
* Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone.
*/
usePartitionedTables?: boolean | null;
/**
* Output only. True if new timestamp column based partitioning is in use, false if legacy ingress-time partitioning is in use.All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.
*/
usesTimestampColumnPartitioning?: boolean | null;
}
/**
* Associates members, or principals, with a role.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid\}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid\}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid\}: An email address that represents a Google group. For example, admins@example.com. domain:{domain\}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x: All identities in a workload identity pool. deleted:user:{emailid\}?uid={uniqueid\}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid\} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid\}?uid={uniqueid\}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid\} and the undeleted service account retains the role in the binding. deleted:group:{emailid\}?uid={uniqueid\}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid\} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* Metadata for LongRunningUpdateBucket Operations.
*/
export interface Schema$BucketMetadata {
/**
* LongRunningCreateBucket RPC request.
*/
createBucketRequest?: Schema$CreateBucketRequest;
/**
* The end time of an operation.
*/
endTime?: string | null;
/**
* The create time of an operation.
*/
startTime?: string | null;
/**
* Output only. State of an operation.
*/
state?: string | null;
/**
* LongRunningUpdateBucket RPC request.
*/
updateBucketRequest?: Schema$UpdateBucketRequest;
}
/**
* BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \> 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
*/
export interface Schema$BucketOptions {
/**
* The explicit buckets.
*/
explicitBuckets?: Schema$Explicit;
/**
* The exponential buckets.
*/
exponentialBuckets?: Schema$Exponential;
/**
* The linear bucket.
*/
linearBuckets?: Schema$Linear;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
*/
export interface Schema$CmekSettings {
/**
* Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
*/
kmsKeyName?: string | null;
/**
* Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.
*/
kmsKeyVersionName?: string | null;
/**
* Output only. The resource name of the CMEK settings.
*/
name?: string | null;
/**
* Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
*/
serviceAccountId?: string | null;
}
/**
* Metadata for CopyLogEntries long running operations.
*/
export interface Schema$CopyLogEntriesMetadata {
/**
* Identifies whether the user has requested cancellation of the operation.
*/
cancellationRequested?: boolean | null;
/**
* Destination to which to copy log entries.For example, a Cloud Storage bucket:"storage.googleapis.com/my-cloud-storage-bucket"
*/
destination?: string | null;
/**
* The end time of an operation.
*/
endTime?: string | null;
/**
* Estimated progress of the operation (0 - 100%).
*/
progress?: number | null;
/**
* CopyLogEntries RPC request. This field is deprecated and not used.
*/
request?: Schema$CopyLogEntriesRequest;
/**
* Source from which to copy log entries.For example, a log bucket:"projects/my-project/locations/global/buckets/my-source-bucket"
*/
source?: string | null;
/**
* The create time of an operation.
*/
startTime?: string | null;
/**
* Output only. State of an operation.
*/
state?: string | null;
/**
* Name of the verb executed by the operation.For example,"copy"
*/
verb?: string | null;
/**
* The IAM identity of a service account that must be granted access to the destination.If the service account is not granted permission to the destination within an hour, the operation will be cancelled.For example: "serviceAccount:foo@bar.com"
*/
writerIdentity?: string | null;
}
/**
* The parameters to CopyLogEntries.
*/
export interface Schema$CopyLogEntriesRequest {
/**
* Required. Destination to which to copy log entries. For example: "storage.googleapis.com/GCS_BUCKET"
*/
destination?: string | null;
/**
* Optional. A filter specifying which log entries to copy. The filter must be no more than 20k characters. An empty filter matches all log entries.
*/
filter?: string | null;
/**
* Required. Log bucket from which to copy log entries.For example:"projects/my-project/locations/global/buckets/my-source-bucket"
*/
name?: string | null;
}
/**
* Response type for CopyLogEntries long running operations.
*/
export interface Schema$CopyLogEntriesResponse {
/**
* Number of log entries copied.
*/
logEntriesCopiedCount?: string | null;
}
/**
* The parameters to CreateBucket.
*/
export interface Schema$CreateBucketRequest {
/**
* Required. The new bucket. The region specified in the new bucket must be compliant with any Location Restriction Org Policy. The name field in the bucket is ignored.
*/
bucket?: Schema$LogBucket;
/**
* Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character.
*/
bucketId?: string | null;
/**
* Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"
*/
parent?: string | null;
}
/**
* The parameters to CreateLink.
*/
export interface Schema$CreateLinkRequest {
/**
* Required. The new link.
*/
link?: Schema$Link;
/**
* Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it.
*/
linkId?: string | null;
/**
* Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"
*/
parent?: string | null;
}
/**
* Describes the custom _Default sink configuration that is used to override the built-in _Default sink configuration in newly created resource containers, such as projects or folders.
*/
export interface Schema$DefaultSinkConfig {
/**
* Optional. Specifies the set of exclusions to be added to the _Default sink in newly created resource containers.
*/
exclusions?: Schema$LogExclusion[];
/**
* Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter.For example:logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity\>=ERRORTo match all logs, don't add exclusions and use the following line as the value of filter:logName:*Cannot be empty or unset when the value of mode is OVERWRITE.
*/
filter?: string | null;
/**
* Required. Determines the behavior to apply to the built-in _Default sink inclusion filter.Exclusions are always appended, as built-in _Default sinks have no exclusions.
*/
mode?: string | null;
}
/**
* The parameters to DeleteLink.
*/
export interface Schema$DeleteLinkRequest {
/**
* Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]"
*/
name?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
*/
export interface Schema$Explicit {
/**
* The values must be monotonically increasing.
*/
bounds?: number[] | null;
}
/**
* Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
*/
export interface Schema$Exponential {
/**
* Must be greater than 1.
*/
growthFactor?: number | null;
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number | null;
/**
* Must be greater than 0.
*/
scale?: number | null;
}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Request message for GetIamPolicy method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
*/
requestedPolicyVersion?: number | null;
}
/**
* A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
*/
export interface Schema$HttpRequest {
/**
* The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
*/
cacheFillBytes?: string | null;
/**
* Whether or not an entity was served from cache (with or without validation).
*/
cacheHit?: boolean | null;
/**
* Whether or not a cache lookup was attempted.
*/
cacheLookup?: boolean | null;
/**
* Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.
*/
cacheValidatedWithOriginServer?: boolean | null;
/**
* The request processing latency on the server, from the time the request was received until the response was sent. For WebSocket connections, this field refers to the entire time duration of the connection.
*/
latency?: string | null;
/**
* Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2"
*/
protocol?: string | null;
/**
* The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (https://datatracker.ietf.org/doc/html/rfc2616#section-14.36).
*/
referer?: string | null;
/**
* The IP address (IPv4 or IPv6) of the client that issued the HTTP request. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
*/
remoteIp?: string | null;
/**
* The request method. Examples: "GET", "HEAD", "PUT", "POST".
*/
requestMethod?: string | null;
/**
* The size of the HTTP request message in bytes, including the request headers and the request body.
*/
requestSize?: string | null;
/**
* The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red".
*/
requestUrl?: string | null;
/**
* The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
*/
responseSize?: string | null;
/**
* The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".
*/
serverIp?: string | null;
/**
* The response code indicating the status of response. Examples: 200, 404.
*/
status?: number | null;
/**
* The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".
*/
userAgent?: string | null;
}
/**
* Configuration for an indexed field.
*/
export interface Schema$IndexConfig {
/**
* Output only. The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.
*/
createTime?: string | null;
/**
* Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/analyze/custom-index) for details.For example: jsonPayload.request.status
*/
fieldPath?: string | null;
/**
* Required. The type of data in this index.
*/
type?: string | null;
}
/**
* A description of a label.
*/
export interface Schema$LabelDescriptor {
/**
* A human-readable description for the label.
*/
description?: string | null;
/**
* The label key.
*/
key?: string | null;
/**
* The type of data that can be assigned to the label.
*/
valueType?: string | null;
}
/**
* Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i).Lower bound (1 <= i < N): offset + (width * (i - 1)).
*/
export interface Schema$Linear {
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number | null;
/**
* Lower bound of the first bucket.
*/
offset?: number | null;
/**
* Must be greater than 0.
*/
width?: number | null;
}
/**
* Describes a link connected to an analytics enabled bucket.
*/
export interface Schema$Link {
/**
* Optional. The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket.
*/
bigqueryDataset?: Schema$BigQueryDataset;
/**
* Output only. The creation timestamp of the link.
*/
createTime?: string | null;
/**
* Optional. Describes this link.The maximum length of the description is 8000 characters.
*/
description?: string | null;
/**
* Output only. The resource lifecycle state.
*/
lifecycleState?: string | null;
/**
* Output only. The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link
*/
name?: string | null;
}
/**
* Metadata for long running Link operations.
*/
export interface Schema$LinkMetadata {
/**
* CreateLink RPC request.
*/
createLinkRequest?: Schema$CreateLinkRequest;
/**
* DeleteLink RPC request.
*/
deleteLinkRequest?: Schema$DeleteLinkRequest;
/**
* The end time of an operation.
*/
endTime?: string | null;
/**
* The start time of an operation.
*/
startTime?: string | null;
/**
* Output only. State of an operation.
*/
state?: string | null;
}
/**
* The response from ListBuckets.
*/
export interface Schema$ListBucketsResponse {
/**
* A list of buckets.
*/
buckets?: Schema$LogBucket[];
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
}
/**
* Result returned from ListExclusions.
*/
export interface Schema$ListExclusionsResponse {
/**
* A list of exclusions.
*/
exclusions?: Schema$LogExclusion[];
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
}
/**
* The response from ListLinks.
*/
export interface Schema$ListLinksResponse {
/**
* A list of links.
*/
links?: Schema$Link[];
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The parameters to ListLogEntries.
*/
export interface Schema$ListLogEntriesRequest {
/**
* Optional. A filter that chooses which log entries to return. For more information, see Logging query language (https://{$universe.dns_names.final_documentation_domain\}/logging/docs/view/logging-query-language).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.To make queries faster, you can make the filter more selective by using restrictions on indexed fields (https://{$universe.dns_names.final_documentation_domain\}/logging/docs/view/logging-query-language#indexed-fields) as well as limit the time range of the query by adding range restrictions on the timestamp field.
*/
filter?: string | null;
/**
* 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.We recommend setting the order_by field to "timestamp desc" when listing recently ingested log entries. If not set, the default value of "timestamp asc" may take a long time to fetch matching logs that are only recently ingested.
*/
orderBy?: string | null;
/**
* Optional. The maximum number of results to return from this request. Default is 50. If the value is negative, the request is rejected.The presence of next_page_token in the response indicates that more results might be available.
*/
pageSize?: number | null;
/**
* 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.
*/
pageToken?: string | null;
/**
* Optional. Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A".
*/
projectIds?: string[] | null;
/**
* Required. Names of one or more parent resources from which to retrieve log entries. Resources may either be resource containers or specific LogViews. For the case of resource containers, all logs ingested into that container will be returned regardless of which LogBuckets they are actually stored in - i.e. these queries may fan out to multiple regions. In the event of region unavailability, specify a specific set of LogViews that do not include the unavailable region. projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] 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.
*/
resourceNames?: string[] | null;
}
/**
* Result returned from ListLogEntries.
*/
export interface Schema$ListLogEntriesResponse {
/**
* A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.
*/
entries?: Schema$LogEntry[];
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.
*/
nextPageToken?: string | null;
}
/**
* Result returned from ListLogMetrics.
*/
export interface Schema$ListLogMetricsResponse {
/**
* A list of logs-based metrics.
*/
metrics?: Schema$LogMetric[];
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
}
/**
* The response from ListLogScopes. Every project has a _Default log scope that cannot be modified or deleted.
*/
export interface Schema$ListLogScopesResponse {
/**
* A list of log scopes.
*/
logScopes?: Schema$LogScope[];
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
}
/**
* Result returned from ListLogs.
*/
export interface Schema$ListLogsResponse {
/**
* A list of log names. For example, "projects/my-project/logs/syslog" or "organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity".
*/
logNames?: string[] | null;
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
}
/**
* Result returned from ListMonitoredResourceDescriptors.
*/
export interface Schema$ListMonitoredResourceDescriptorsResponse {
/**
* If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
/**
* A list of resource descriptors.
*/
resourceDescriptors?: Schema$MonitoredResourceDescriptor[];
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
/**
* Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations.
*/
unreachable?: string[] | null;
}
/**
* The response from ListRecentQueries.
*/
export interface Schema$ListRecentQueriesResponse {
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
/**
* A list of recent queries.
*/
recentQueries?: Schema$RecentQuery[];
/**
* The unreachable resources. Each resource can be either 1) a saved query if a specific query is unreachable or 2) a location if a specific location is unreachable. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]" "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/recentQueries/12345678" "projects/my-project/locations/global"If there are unreachable resources, the response will first return pages that contain recent queries, and then return pages that contain the unreachable resources.
*/
unreachable?: string[] | null;
}
/**
* The response from ListSavedQueries.
*/
export interface Schema$ListSavedQueriesResponse {
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
/**
* A list of saved queries.
*/
savedQueries?: Schema$SavedQuery[];
/**
* The unreachable resources. It can be either 1) a saved query if a specific query is unreachable or 2) a location if a specific location is unreachabe. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/global/savedQueries/12345678" "projects/my-project/locations/global" If there are unreachable resources, the response will first return pages that contain saved queries, and then return pages that contain the unreachable resources.
*/
unreachable?: string[] | null;
}
/**
* Result returned from ListSinks.
*/
export interface Schema$ListSinksResponse {
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
/**
* A list of sinks.
*/
sinks?: Schema$LogSink[];
}
/**
* The response from ListViews.
*/
export interface Schema$ListViewsResponse {
/**
* If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
*/
nextPageToken?: string | null;
/**
* A list of views.
*/
views?: Schema$LogView[];
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: "us-east1".
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
*/
name?: string | null;
}
/**
* Cloud Logging specific location metadata.
*/
export interface Schema$LocationMetadata {
/**
* Indicates whether or not Log Analytics features are supported in the given location.
*/
logAnalyticsEnabled?: boolean | null;
}
/**
* Describes a repository in which log entries are stored.
*/
export interface Schema$LogBucket {
/**
* Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.
*/
analyticsEnabled?: boolean | null;
/**
* Optional. The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.
*/
cmekSettings?: Schema$CmekSettings;
/**
* Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.
*/
createTime?: string | null;
/**
* Optional. Describes this bucket.
*/
description?: string | null;
/**
* Optional. A list of indexed fields and related configuration data.
*/
indexConfigs?: Schema$IndexConfig[];
/**
* Output only. The bucket l