googleapis
Version:
Google APIs Client Library for Node.js
1,363 lines (1,362 loc) • 197 kB
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 datastream_v1alpha1 {
export interface Options extends GlobalOptions {
version: 'v1alpha1';
}
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;
}
/**
* Datastream API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const datastream = google.datastream('v1alpha1');
* ```
*/
export class Datastream {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* AVRO file format configuration.
*/
export interface Schema$AvroFileFormat {
}
/**
* Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.
*/
export interface Schema$BackfillAllStrategy {
/**
* MySQL data source objects to avoid backfilling.
*/
mysqlExcludedObjects?: Schema$MysqlRdbms;
/**
* Oracle data source objects to avoid backfilling.
*/
oracleExcludedObjects?: Schema$OracleRdbms;
}
/**
* Represents a backfill job on a specific stream object.
*/
export interface Schema$BackfillJob {
/**
* Output only. Errors which caused the backfill job to fail.
*/
errors?: Schema$Error[];
/**
* Output only. Backfill job's end time.
*/
lastEndTime?: string | null;
/**
* Output only. Backfill job's start time.
*/
lastStartTime?: string | null;
/**
* Backfill job state.
*/
state?: string | null;
/**
* Backfill job's triggering reason.
*/
trigger?: string | null;
}
/**
* Backfill strategy to disable automatic backfill for the Stream's objects.
*/
export interface Schema$BackfillNoneStrategy {
}
/**
* Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
*/
export interface Schema$BadRequest {
/**
* Describes all violations in a client request.
*/
fieldViolations?: Schema$FieldViolation[];
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
export interface Schema$ConnectionProfile {
/**
* Output only. The create time of the resource.
*/
createTime?: string | null;
/**
* Required. Display name.
*/
displayName?: string | null;
/**
* Forward SSH tunnel connectivity.
*/
forwardSshConnectivity?: Schema$ForwardSshTunnelConnectivity;
/**
* Cloud Storage ConnectionProfile configuration.
*/
gcsProfile?: Schema$GcsProfile;
/**
* Labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* MySQL ConnectionProfile configuration.
*/
mysqlProfile?: Schema$MysqlProfile;
/**
* Output only. The resource's name.
*/
name?: string | null;
/**
* No connectivity option chosen.
*/
noConnectivity?: Schema$NoConnectivitySettings;
/**
* Oracle ConnectionProfile configuration.
*/
oracleProfile?: Schema$OracleProfile;
/**
* Private connectivity.
*/
privateConnectivity?: Schema$PrivateConnectivity;
/**
* Static Service IP connectivity.
*/
staticServiceIpConnectivity?: Schema$StaticServiceIpConnectivity;
/**
* Output only. The update time of the resource.
*/
updateTime?: string | null;
}
/**
* Describes additional debugging info.
*/
export interface Schema$DebugInfo {
/**
* Additional debugging information provided by the server.
*/
detail?: string | null;
/**
* The stack trace entries indicating where the error occurred.
*/
stackEntries?: string[] | null;
}
/**
* The configuration of the stream destination.
*/
export interface Schema$DestinationConfig {
/**
* Required. Destination connection profile identifier.
*/
destinationConnectionProfileName?: string | null;
/**
* GCS destination configuration.
*/
gcsDestinationConfig?: Schema$GcsDestinationConfig;
}
/**
* Request message for 'discover' ConnectionProfile request.
*/
export interface Schema$DiscoverConnectionProfileRequest {
/**
* An ad-hoc ConnectionProfile configuration.
*/
connectionProfile?: Schema$ConnectionProfile;
/**
* A reference to an existing ConnectionProfile.
*/
connectionProfileName?: string | null;
/**
* MySQL RDBMS to enrich with child data objects and metadata.
*/
mysqlRdbms?: Schema$MysqlRdbms;
/**
* Oracle RDBMS to enrich with child data objects and metadata.
*/
oracleRdbms?: Schema$OracleRdbms;
/**
* The number of hierarchy levels below the current level to be retrieved.
*/
recursionDepth?: number | null;
/**
* Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).
*/
recursive?: boolean | null;
}
export interface Schema$DiscoverConnectionProfileResponse {
/**
* Enriched MySQL RDBMS object.
*/
mysqlRdbms?: Schema$MysqlRdbms;
/**
* Enriched Oracle RDBMS object.
*/
oracleRdbms?: Schema$OracleRdbms;
}
/**
* Configuration to drop large object values.
*/
export interface Schema$DropLargeObjects {
}
/**
* 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 {
}
/**
* Represent a user-facing Error.
*/
export interface Schema$Error {
/**
* Additional information about the error.
*/
details?: {
[key: string]: string;
} | null;
/**
* The time when the error occurred.
*/
errorTime?: string | null;
/**
* A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
*/
errorUuid?: string | null;
/**
* A message containing more information about the error that occurred.
*/
message?: string | null;
/**
* A title that explains the reason for the error.
*/
reason?: string | null;
}
/**
* Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" \} \} This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" \} \}
*/
export interface Schema$ErrorInfo {
/**
* The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
*/
domain?: string | null;
/**
* Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"\}`, should be returned as, `{"instanceLimitPerRequest": "100"\}`, if the client exceeds the number of instances that can be created in a single (batch) request.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* The reason for the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
*/
reason?: string | null;
}
/**
* Request message for 'FetchErrors' request.
*/
export interface Schema$FetchErrorsRequest {
}
/**
* Response message for a 'FetchErrors' response.
*/
export interface Schema$FetchErrorsResponse {
/**
* The list of errors on the Stream.
*/
errors?: Schema$Error[];
}
/**
* Response message for a 'FetchStaticIps' response.
*/
export interface Schema$FetchStaticIpsResponse {
/**
* A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* list of static ips by account
*/
staticIps?: string[] | null;
}
/**
* A message type used to describe a single bad request field.
*/
export interface Schema$FieldViolation {
/**
* A description of why the request element is bad.
*/
description?: string | null;
/**
* A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; \} optional string email = 1; repeated EmailType type = 2; \} string full_name = 1; repeated EmailAddress email_addresses = 2; \} In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[0].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[2].type[1]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[0].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[2].type[1]` for a violation in the second `type` value in the third `emailAddresses` message.
*/
field?: string | null;
/**
* Provides a localized error message for field-level errors that is safe to return to the API consumer.
*/
localizedMessage?: Schema$LocalizedMessage;
/**
* The reason for the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
*/
reason?: string | null;
}
/**
* Forward SSH Tunnel connectivity.
*/
export interface Schema$ForwardSshTunnelConnectivity {
/**
* Required. Hostname for the SSH tunnel.
*/
hostname?: string | null;
/**
* Input only. SSH password.
*/
password?: string | null;
/**
* Port for the SSH tunnel, default value is 22.
*/
port?: number | null;
/**
* Input only. SSH private key.
*/
privateKey?: string | null;
/**
* Required. Username for the SSH tunnel.
*/
username?: string | null;
}
/**
* Google Cloud Storage destination configuration
*/
export interface Schema$GcsDestinationConfig {
/**
* AVRO file format configuration.
*/
avroFileFormat?: Schema$AvroFileFormat;
/**
* The maximum duration for which new events are added before a file is closed and a new file is created.
*/
fileRotationInterval?: string | null;
/**
* The maximum file size to be saved in the bucket.
*/
fileRotationMb?: number | null;
/**
* File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
*/
gcsFileFormat?: string | null;
/**
* JSON file format configuration.
*/
jsonFileFormat?: Schema$JsonFileFormat;
/**
* Path inside the Cloud Storage bucket to write data to.
*/
path?: string | null;
}
/**
* Cloud Storage bucket profile.
*/
export interface Schema$GcsProfile {
/**
* Required. The full project and resource path for Cloud Storage bucket including the name.
*/
bucketName?: string | null;
/**
* The root path inside the Cloud Storage bucket.
*/
rootPath?: string | null;
}
/**
* Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
*/
export interface Schema$Help {
/**
* URL(s) pointing to additional information on handling the current error.
*/
links?: Schema$Link[];
}
/**
* JSON file format configuration.
*/
export interface Schema$JsonFileFormat {
/**
* Compression of the loaded JSON file.
*/
compression?: string | null;
/**
* The schema file format along JSON data files.
*/
schemaFileFormat?: string | null;
}
/**
* Describes a URL link.
*/
export interface Schema$Link {
/**
* Describes what the link offers.
*/
description?: string | null;
/**
* The URL of the link.
*/
url?: string | null;
}
export interface Schema$ListConnectionProfilesResponse {
/**
* List of connection profiles.
*/
connectionProfiles?: Schema$ConnectionProfile[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: 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 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;
}
export interface Schema$ListPrivateConnectionsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* List of private connectivity configurations.
*/
privateConnections?: Schema$PrivateConnection[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* route list response
*/
export interface Schema$ListRoutesResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* List of Routes.
*/
routes?: Schema$Route[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response containing the objects for a stream.
*/
export interface Schema$ListStreamObjectsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page.
*/
nextPageToken?: string | null;
/**
* List of stream objects.
*/
streamObjects?: Schema$StreamObject[];
}
export interface Schema$ListStreamsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* List of streams
*/
streams?: Schema$Stream[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
*/
export interface Schema$LocalizedMessage {
/**
* The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
*/
locale?: string | null;
/**
* The localized error message in the above locale.
*/
message?: string | null;
}
/**
* 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;
}
/**
* MySQL Column.
*/
export interface Schema$MysqlColumn {
/**
* Column collation.
*/
collation?: string | null;
/**
* Column name.
*/
columnName?: string | null;
/**
* The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html
*/
dataType?: string | null;
/**
* Column length.
*/
length?: number | null;
/**
* Whether or not the column can accept a null value.
*/
nullable?: boolean | null;
/**
* The ordinal position of the column in the table.
*/
ordinalPosition?: number | null;
/**
* Whether or not the column represents a primary key.
*/
primaryKey?: boolean | null;
}
/**
* MySQL database.
*/
export interface Schema$MysqlDatabase {
/**
* Database name.
*/
databaseName?: string | null;
/**
* Tables in the database.
*/
mysqlTables?: Schema$MysqlTable[];
}
/**
* Mysql data source object identifier.
*/
export interface Schema$MysqlObjectIdentifier {
/**
* Required. The database name.
*/
database?: string | null;
/**
* Required. The table name.
*/
table?: string | null;
}
/**
* MySQL database profile.
*/
export interface Schema$MysqlProfile {
/**
* Required. Hostname for the MySQL connection.
*/
hostname?: string | null;
/**
* Required. Input only. Password for the MySQL connection.
*/
password?: string | null;
/**
* Port for the MySQL connection, default value is 3306.
*/
port?: number | null;
/**
* SSL configuration for the MySQL connection.
*/
sslConfig?: Schema$MysqlSslConfig;
/**
* Required. Username for the MySQL connection.
*/
username?: string | null;
}
/**
* MySQL database structure
*/
export interface Schema$MysqlRdbms {
/**
* Mysql databases on the server
*/
mysqlDatabases?: Schema$MysqlDatabase[];
}
/**
* MySQL source configuration
*/
export interface Schema$MysqlSourceConfig {
/**
* MySQL objects to retrieve from the source.
*/
allowlist?: Schema$MysqlRdbms;
/**
* MySQL objects to exclude from the stream.
*/
rejectlist?: Schema$MysqlRdbms;
}
/**
* MySQL SSL configuration information.
*/
export interface Schema$MysqlSslConfig {
/**
* Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
*/
caCertificate?: string | null;
/**
* Output only. Indicates whether the ca_certificate field is set.
*/
caCertificateSet?: boolean | null;
/**
* Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
*/
clientCertificate?: string | null;
/**
* Output only. Indicates whether the client_certificate field is set.
*/
clientCertificateSet?: boolean | null;
/**
* Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
*/
clientKey?: string | null;
/**
* Output only. Indicates whether the client_key field is set.
*/
clientKeySet?: boolean | null;
}
/**
* MySQL table.
*/
export interface Schema$MysqlTable {
/**
* MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
*/
mysqlColumns?: Schema$MysqlColumn[];
/**
* Table name.
*/
tableName?: string | null;
}
/**
* No connectivity settings.
*/
export interface Schema$NoConnectivitySettings {
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Results of executed validations if there are any.
*/
validationResult?: Schema$ValidationResult;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Oracle Column.
*/
export interface Schema$OracleColumn {
/**
* Column name.
*/
columnName?: string | null;
/**
* The Oracle data type.
*/
dataType?: string | null;
/**
* Column encoding.
*/
encoding?: string | null;
/**
* Column length.
*/
length?: number | null;
/**
* Whether or not the column can accept a null value.
*/
nullable?: boolean | null;
/**
* The ordinal position of the column in the table.
*/
ordinalPosition?: number | null;
/**
* Column precision.
*/
precision?: number | null;
/**
* Whether or not the column represents a primary key.
*/
primaryKey?: boolean | null;
/**
* Column scale.
*/
scale?: number | null;
}
/**
* Oracle data source object identifier.
*/
export interface Schema$OracleObjectIdentifier {
/**
* Required. The schema name.
*/
schema?: string | null;
/**
* Required. The table name.
*/
table?: string | null;
}
/**
* Oracle database profile.
*/
export interface Schema$OracleProfile {
/**
* Connection string attributes
*/
connectionAttributes?: {
[key: string]: string;
} | null;
/**
* Required. Database for the Oracle connection.
*/
databaseService?: string | null;
/**
* Required. Hostname for the Oracle connection.
*/
hostname?: string | null;
/**
* Required. Password for the Oracle connection.
*/
password?: string | null;
/**
* Port for the Oracle connection, default value is 1521.
*/
port?: number | null;
/**
* Required. Username for the Oracle connection.
*/
username?: string | null;
}
/**
* Oracle database structure.
*/
export interface Schema$OracleRdbms {
/**
* Oracle schemas/databases in the database server.
*/
oracleSchemas?: Schema$OracleSchema[];
}
/**
* Oracle schema.
*/
export interface Schema$OracleSchema {
/**
* Tables in the schema.
*/
oracleTables?: Schema$OracleTable[];
/**
* Schema name.
*/
schemaName?: string | null;
}
/**
* Oracle data source configuration
*/
export interface Schema$OracleSourceConfig {
/**
* Oracle objects to include in the stream.
*/
allowlist?: Schema$OracleRdbms;
/**
* Drop large object values.
*/
dropLargeObjects?: Schema$DropLargeObjects;
/**
* Oracle objects to exclude from the stream.
*/
rejectlist?: Schema$OracleRdbms;
}
/**
* Oracle table.
*/
export interface Schema$OracleTable {
/**
* Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
*/
oracleColumns?: Schema$OracleColumn[];
/**
* Table name.
*/
tableName?: string | null;
}
/**
* Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.
*/
export interface Schema$PreconditionFailure {
/**
* Describes all precondition violations.
*/
violations?: Schema$PreconditionFailureViolation[];
}
/**
* A message type used to describe a single precondition failure.
*/
export interface Schema$PreconditionFailureViolation {
/**
* A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".
*/
description?: string | null;
/**
* The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.
*/
subject?: string | null;
/**
* The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".
*/
type?: string | null;
}
/**
* The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.
*/
export interface Schema$PrivateConnection {
/**
* Output only. The create time of the resource.
*/
createTime?: string | null;
/**
* Required. Display name.
*/
displayName?: string | null;
/**
* Output only. In case of error, the details of the error in a user-friendly format.
*/
error?: Schema$Error;
/**
* Labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The resource's name.
*/
name?: string | null;
/**
* Output only. The state of the Private Connection.
*/
state?: string | null;
/**
* Output only. The update time of the resource.
*/
updateTime?: string | null;
/**
* VPC Peering Config
*/
vpcPeeringConfig?: Schema$VpcPeeringConfig;
}
/**
* Private Connectivity
*/
export interface Schema$PrivateConnectivity {
privateConnectionName?: string | null;
}
/**
* Describes how a quota check failed. For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set `service_disabled` to true. Also see RetryInfo and Help types for other details about handling a quota failure.
*/
export interface Schema$QuotaFailure {
/**
* Describes all quota violations.
*/
violations?: Schema$QuotaFailureViolation[];
}
/**
* A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
*/
export interface Schema$QuotaFailureViolation {
/**
* The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be "container.googleapis.com". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be "compute.googleapis.com".
*/
apiService?: string | null;
/**
* A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console. For example: "Service disabled" or "Daily Limit for read operations exceeded".
*/
description?: string | null;
/**
* The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set. For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.
*/
futureQuotaValue?: string | null;
/**
* The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased. For example, the quota "CPUs per region per VM family" enforces a limit on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions "region" and "vm_family". And if the violation occurred in region "us-central1" and for VM family "n1", the quota_dimensions would be, { "region": "us-central1", "vm_family": "n1", \} When a quota is enforced globally, the quota_dimensions would always be empty.
*/
quotaDimensions?: {
[key: string]: string;
} | null;
/**
* The id of the violated quota. Also know as "limit name", this is the unique identifier of a quota in the context of an API service. For example, "CPUS-PER-VM-FAMILY-per-project-region".
*/
quotaId?: string | null;
/**
* The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected. For example, "compute.googleapis.com/cpus_per_vm_family", "storage.googleapis.com/internet_egress_bandwidth".
*/
quotaMetric?: string | null;
/**
* The enforced quota value at the time of the `QuotaFailure`. For example, if the enforced quota value at the time of the `QuotaFailure` on the number of CPUs is "10", then the value of this field would reflect this quantity.
*/
quotaValue?: string | null;
/**
* The subject on which the quota check failed. For example, "clientip:" or "project:".
*/
subject?: string | null;
}
/**
* Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
*/
export interface Schema$RequestInfo {
/**
* An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
*/
requestId?: string | null;
/**
* Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
*/
servingData?: string | null;
}
/**
* Describes the resource that is being accessed.
*/
export interface Schema$ResourceInfo {
/**
* Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the `writer` permission on the developer console project.
*/
description?: string | null;
/**
* The owner of the resource (optional). For example, "user:" or "project:".
*/
owner?: string | null;
/**
* The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is google.rpc.Code.PERMISSION_DENIED.
*/
resourceName?: string | null;
/**
* A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
*/
resourceType?: string | null;
}
/**
* Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses. It's always recommended that clients should use exponential backoff when retrying. Clients should wait until `retry_delay` amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on `retry_delay`, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.
*/
export interface Schema$RetryInfo {
/**
* Clients should wait at least this long between retrying the same request.
*/
retryDelay?: string | null;
}
/**
* The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.
*/
export interface Schema$Route {
/**
* Output only. The create time of the resource.
*/
createTime?: string | null;
/**
* Required. Destination address for connection
*/
destinationAddress?: string | null;
/**
* Destination port for connection
*/
destinationPort?: number | null;
/**
* Required. Display name.
*/
displayName?: string | null;
/**
* Labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The resource's name.
*/
name?: string | null;
/**
* Output only. The update time of the resource.
*/
updateTime?: string | null;
}
/**
* The configuration of the stream source.
*/
export interface Schema$SourceConfig {
/**
* MySQL data source configuration
*/
mysqlSourceConfig?: Schema$MysqlSourceConfig;
/**
* Oracle data source configuration
*/
oracleSourceConfig?: Schema$OracleSourceConfig;
/**
* Required. Source connection profile identifier.
*/
sourceConnectionProfileName?: string | null;
}
/**
* Represents an identifier of an object in the data source.
*/
export interface Schema$SourceObjectIdentifier {
/**
* Mysql data source object identifier.
*/
mysqlIdentifier?: Schema$MysqlObjectIdentifier;
/**
* Oracle data source object identifier.
*/
oracleIdentifier?: Schema$OracleObjectIdentifier;
}
/**
* Response for manually initiating a backfill job for a specific stream object.
*/
export interface Schema$StartBackfillJobResponse {
/**
* The stream object resource a backfill job was started for.
*/
object?: Schema$StreamObject;
}
/**
* Static IP address connectivity.
*/
export interface Schema$StaticServiceIpConnectivity {
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* Response for manually stop a backfill job for a specific stream object.
*/
export interface Schema$StopBackfillJobResponse {
/**
* The stream object resource the backfill job was stopped for.
*/
object?: Schema$StreamObject;
}
export interface Schema$Stream {
/**
* Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
*/
backfillAll?: Schema$BackfillAllStrategy;
/**
* Do not automatically backfill any objects.
*/
backfillNone?: Schema$BackfillNoneStrategy;
/**
* Output only. The creation time of the stream.
*/
createTime?: string | null;
/**
* Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.
*/
customerManagedEncryptionKey?: string | null;
/**
* Required. Destination connection profile configuration.
*/
destinationConfig?: Schema$DestinationConfig;
/**
* Required. Display name.
*/
displayName?: string | null;
/**
* Output only. Errors on the Stream.
*/
errors?: Schema$Error[];
/**
* Labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The stream's name.
*/
name?: string | null;
/**
* Required. Source connection profile configuration.
*/
sourceConfig?: Schema$SourceConfig;
/**
* The state of the stream.
*/
state?: string | null;
/**
* Output only. The last update time of the stream.
*/
updateTime?: string | null;
}
/**
* A specific stream object (e.g a specific DB table).
*/
export interface Schema$StreamObject {
/**
* The latest backfill job that was initiated for the stream object.
*/
backfillJob?: Schema$BackfillJob;
/**
* Output only. The creation time of the object.
*/
createTime?: string | null;
/**
* Required. Display name.
*/
displayName?: string | null;
/**
* Output only. Active errors on the object.
*/
errors?: Schema$Error[];
/**
* Output only. The object's name.
*/
name?: string | null;
/**
* The object identifier in the data source.
*/
sourceObject?: Schema$SourceObjectIdentifier;
/**
* Output only. The last update time of the object.
*/
updateTime?: string | null;
}
export interface Schema$Validation {
/**
* A custom code identifying this validation.
*/
code?: string | null;
/**
* A short description of the validation.
*/
description?: string | null;
/**
* Messages reflecting the validation results.
*/
message?: Schema$ValidationMessage[];
/**
* Validation execution status.
*/
status?: string | null;
}
/**
* Represent user-facing validation result message.
*/
export interface Schema$ValidationMessage {
/**
* A custom code identifying this specific message.
*/
code?: string | null;
/**
* Message severity level (warning or error).
*/
level?: string | null;
/**
* The result of the validation.
*/
message?: string | null;
/**
* Additional metadata related to the result.
*/
metadata?: {
[key: string]: string;
} | null;
}
/**
* Contains the current validation results.
*/
export interface Schema$ValidationResult {
/**
* A list of validations (includes both executed as well as not executed validations).
*/
validations?: Schema$Validation[];
}
/**