googleapis
Version:
Google APIs Client Library for Node.js
1,178 lines • 166 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace connectors_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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;
}
/**
* Connectors API
*
* Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.
*
* @example
* ```js
* const {google} = require('googleapis');
* const connectors = google.connectors('v1');
* ```
*/
export class Connectors {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
*/
service?: string | null;
}
/**
* Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* AuthConfig defines details of a authentication type.
*/
export interface Schema$AuthConfig {
/**
* List containing additional auth configs.
*/
additionalVariables?: Schema$ConfigVariable[];
/**
* The type of authentication configured.
*/
authType?: string | null;
/**
* Oauth2ClientCredentials.
*/
oauth2ClientCredentials?: Schema$Oauth2ClientCredentials;
/**
* Oauth2JwtBearer.
*/
oauth2JwtBearer?: Schema$Oauth2JwtBearer;
/**
* SSH Public Key.
*/
sshPublicKey?: Schema$SshPublicKey;
/**
* UserPassword.
*/
userPassword?: Schema$UserPassword;
}
/**
* AuthConfigTemplate defines required field over an authentication type.
*/
export interface Schema$AuthConfigTemplate {
/**
* The type of authentication configured.
*/
authType?: string | null;
/**
* Config variables to describe an `AuthConfig` for a `Connection`.
*/
configVariableTemplates?: Schema$ConfigVariableTemplate[];
}
/**
* This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.
*/
export interface Schema$AuthorizationCodeLink {
/**
* The client ID assigned to the GCP Connectors OAuth app for the connector data source.
*/
clientId?: string | null;
/**
* Whether to enable PKCE for the auth code flow.
*/
enablePkce?: boolean | null;
/**
* The scopes for which the user will authorize GCP Connectors on the connector data source.
*/
scopes?: string[] | null;
/**
* The base URI the user must click to trigger the authorization code login flow.
*/
uri?: string | 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`. * `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. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
*/
export interface Schema$ConfigVariable {
/**
* Value is a bool.
*/
boolValue?: boolean | null;
/**
* Value is an integer
*/
intValue?: string | null;
/**
* Key of the config variable.
*/
key?: string | null;
/**
* Value is a secret.
*/
secretValue?: Schema$Secret;
/**
* Value is a string.
*/
stringValue?: string | null;
}
/**
* ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
*/
export interface Schema$ConfigVariableTemplate {
/**
* Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
*/
authorizationCodeLink?: Schema$AuthorizationCodeLink;
/**
* Description.
*/
description?: string | null;
/**
* Display name of the parameter.
*/
displayName?: string | null;
/**
* Enum options. To be populated if `ValueType` is `ENUM`
*/
enumOptions?: Schema$EnumOption[];
/**
* Key of the config variable.
*/
key?: string | null;
/**
* Flag represents that this `ConfigVariable` must be provided for a connection.
*/
required?: boolean | null;
/**
* Role grant configuration for the config variable.
*/
roleGrant?: Schema$RoleGrant;
/**
* State of the config variable.
*/
state?: string | null;
/**
* Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
*/
validationRegex?: string | null;
/**
* Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
*/
valueType?: string | null;
}
/**
* Connection represents an instance of connector.
*/
export interface Schema$Connection {
/**
* Optional. Configuration for establishing the connection's authentication with an external system.
*/
authConfig?: Schema$AuthConfig;
/**
* Optional. Configuration for configuring the connection with an external system.
*/
configVariables?: Schema$ConfigVariable[];
/**
* Required. Connector version on which the connection is created. The format is: projects/x/locations/x/providers/x/connectors/x/versions/x Only global location is supported for ConnectorVersion resource.
*/
connectorVersion?: string | null;
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Optional. Description of the resource.
*/
description?: string | null;
/**
* Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
*/
destinationConfigs?: Schema$DestinationConfig[];
/**
* Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName\}/{imageName\}
*/
envoyImageLocation?: string | null;
/**
* Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName\}/{imageName\}
*/
imageLocation?: string | null;
/**
* Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. Configuration that indicates whether or not the Connection can be edited.
*/
lockConfig?: Schema$LockConfig;
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/{location\}/connections/{connection\}
*/
name?: string | null;
/**
* Optional. Configuration for the connection.
*/
nodeConfig?: Schema$NodeConfig;
/**
* Optional. Service account needed for runtime plane to access GCP resources.
*/
serviceAccount?: string | null;
/**
* Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
*/
serviceDirectory?: string | null;
/**
* Output only. Current status of the connection.
*/
status?: Schema$ConnectionStatus;
/**
* Optional. Suspended indicates if a user has suspended a connection or not.
*/
suspended?: boolean | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* ConnectionSchemaMetadata is the singleton resource of each connection. It includes the entity and action names of runtime resources exposed by a connection backend.
*/
export interface Schema$ConnectionSchemaMetadata {
/**
* Output only. List of actions.
*/
actions?: string[] | null;
/**
* Output only. List of entity names.
*/
entities?: string[] | null;
/**
* Output only. Resource name. Format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string | null;
/**
* Output only. Timestamp when the connection runtime schema refresh was triggered.
*/
refreshTime?: string | null;
/**
* Output only. The current state of runtime schema.
*/
state?: string | null;
/**
* Output only. Timestamp when the connection runtime schema was updated.
*/
updateTime?: string | null;
}
/**
* ConnectionStatus indicates the state of the connection.
*/
export interface Schema$ConnectionStatus {
/**
* Description.
*/
description?: string | null;
/**
* State.
*/
state?: string | null;
/**
* Status provides detailed information for the state.
*/
status?: string | null;
}
/**
* Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.
*/
export interface Schema$Connector {
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Output only. Description of the resource.
*/
description?: string | null;
/**
* Output only. Display name.
*/
displayName?: string | null;
/**
* Output only. Link to documentation page.
*/
documentationUri?: string | null;
/**
* Output only. Link to external page.
*/
externalUri?: string | null;
/**
* Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Flag to mark the version indicating the launch stage.
*/
launchStage?: string | null;
/**
* Output only. Resource name of the Connector. Format: projects/{project\}/locations/{location\}/providers/{provider\}/connectors/{connector\} Only global location is supported for Connector resource.
*/
name?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
/**
* Output only. Cloud storage location of icons etc consumed by UI.
*/
webAssetsLocation?: string | null;
}
/**
* ConnectorVersion indicates a specific version of a connector.
*/
export interface Schema$ConnectorVersion {
/**
* Output only. List of auth configs supported by the Connector Version.
*/
authConfigTemplates?: Schema$AuthConfigTemplate[];
/**
* Output only. List of config variables needed to create a connection.
*/
configVariableTemplates?: Schema$ConfigVariableTemplate[];
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Output only. Display name.
*/
displayName?: string | null;
/**
* Output only. Configuration for Egress Control.
*/
egressControlConfig?: Schema$EgressControlConfig;
/**
* Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Flag to mark the version indicating the launch stage.
*/
launchStage?: string | null;
/**
* Output only. Resource name of the Version. Format: projects/{project\}/locations/{location\}/providers/{provider\}/connectors/{connector\}/versions/{version\} Only global location is supported for Connector resource.
*/
name?: string | null;
/**
* Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha".
*/
releaseVersion?: string | null;
/**
* Output only. Role grant configuration for this config variable. It will be DEPRECATED soon.
*/
roleGrant?: Schema$RoleGrant;
/**
* Output only. Role grant configurations for this connector version.
*/
roleGrants?: Schema$RoleGrant[];
/**
* Output only. Information about the runtime features supported by the Connector.
*/
supportedRuntimeFeatures?: Schema$SupportedRuntimeFeatures;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
export interface Schema$Destination {
/**
* For publicly routable host.
*/
host?: string | null;
/**
* The port is the target port number that is accepted by the destination.
*/
port?: number | null;
/**
* PSC service attachments. Format: projects/x/regions/x/serviceAttachments/x
*/
serviceAttachment?: string | null;
}
/**
* Define the Connectors target endpoint.
*/
export interface Schema$DestinationConfig {
/**
* The destinations for the key.
*/
destinations?: Schema$Destination[];
/**
* The key is the destination identifier that is supported by the Connector.
*/
key?: string | null;
}
/**
* Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource.
*/
export interface Schema$EgressControlConfig {
/**
* Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).
*/
backends?: string | null;
/**
* Extractions Rules to extract the backends from customer provided configuration.
*/
extractionRules?: Schema$ExtractionRules;
}
/**
* 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 {
}
/**
* EnumOption definition
*/
export interface Schema$EnumOption {
/**
* Display name of the option.
*/
displayName?: string | null;
/**
* Id of the option.
*/
id?: string | 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;
}
/**
* Extraction Rule.
*/
export interface Schema$ExtractionRule {
/**
* Regex used to extract backend details from source. If empty, whole source value will be used.
*/
extractionRegex?: string | null;
/**
* Source on which the rule is applied.
*/
source?: Schema$Source;
}
/**
* Extraction Rules to identity the backends from customer provided configuration in Connection resource.
*/
export interface Schema$ExtractionRules {
/**
* Collection of Extraction Rule.
*/
extractionRule?: Schema$ExtractionRule[];
}
/**
* Metadata of an entity field.
*/
export interface Schema$Field {
/**
* The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
*/
additionalDetails?: {
[key: string]: any;
} | null;
/**
* The data type of the Field.
*/
dataType?: string | null;
/**
* The following field specifies the default value of the Field provided by the external system if a value is not provided.
*/
defaultValue?: any | null;
/**
* A brief description of the Field.
*/
description?: string | null;
/**
* Name of the Field.
*/
field?: string | null;
/**
* The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
*/
key?: boolean | null;
/**
* Specifies whether a null value is allowed.
*/
nullable?: boolean | null;
/**
* Specifies if the Field is readonly.
*/
readonly?: boolean | null;
}
/**
* Metadata of an input parameter.
*/
export interface Schema$InputParameter {
/**
* The data type of the Parameter.
*/
dataType?: string | null;
/**
* The following field specifies the default value of the Parameter provided by the external system if a value is not provided.
*/
defaultValue?: any | null;
/**
* A brief description of the Parameter.
*/
description?: string | null;
/**
* Specifies whether a null value is allowed.
*/
nullable?: boolean | null;
/**
* Name of the Parameter.
*/
parameter?: string | null;
}
/**
* JWT claims used for the jwt-bearer authorization grant.
*/
export interface Schema$JwtClaims {
/**
* Value for the "aud" claim.
*/
audience?: string | null;
/**
* Value for the "iss" claim.
*/
issuer?: string | null;
/**
* Value for the "sub" claim.
*/
subject?: string | null;
}
/**
* Response message for ConnectorsService.ListConnections
*/
export interface Schema$ListConnectionsResponse {
/**
* Connections.
*/
connections?: Schema$Connection[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for Connectors.ListConnectors.
*/
export interface Schema$ListConnectorsResponse {
/**
* A list of connectors.
*/
connectors?: Schema$Connector[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for Connectors.ListConnectorVersions.
*/
export interface Schema$ListConnectorVersionsResponse {
/**
* A list of connector versions.
*/
connectorVersions?: Schema$ConnectorVersion[];
/**
* Next page token.
*/
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[];
}
/**
* Response message for Connectors.ListProviders.
*/
export interface Schema$ListProvidersResponse {
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* A list of providers.
*/
providers?: Schema$Provider[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for ConnectorsService.ListRuntimeActionSchemas.
*/
export interface Schema$ListRuntimeActionSchemasResponse {
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Runtime action schemas.
*/
runtimeActionSchemas?: Schema$RuntimeActionSchema[];
}
/**
* Response message for ConnectorsService.ListRuntimeEntitySchemas.
*/
export interface Schema$ListRuntimeEntitySchemasResponse {
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Runtime entity schemas.
*/
runtimeEntitySchemas?: Schema$RuntimeEntitySchema[];
}
/**
* A resource that represents Google Cloud Platform 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;
}
/**
* Determines whether or no a connection is locked. If locked, a reason must be specified.
*/
export interface Schema$LockConfig {
/**
* Indicates whether or not the connection is locked.
*/
locked?: boolean | null;
/**
* Describes why a connection is locked.
*/
reason?: string | null;
}
/**
* Configuration for the connection.
*/
export interface Schema$NodeConfig {
/**
* Maximum number of nodes in the runtime nodes.
*/
maxNodeCount?: number | null;
/**
* Minimum number of nodes in the runtime nodes.
*/
minNodeCount?: number | null;
}
/**
* Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
*/
export interface Schema$Oauth2ClientCredentials {
/**
* The client identifier.
*/
clientId?: string | null;
/**
* Secret version reference containing the client secret.
*/
clientSecret?: Schema$Secret;
}
/**
* Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.
*/
export interface Schema$Oauth2JwtBearer {
/**
* Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/x/secrets/x/versions/x`.
*/
clientKey?: Schema$Secret;
/**
* JwtClaims providers fields to generate the token.
*/
jwtClaims?: Schema$JwtClaims;
}
/**
* 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 response of the operation in case of success. 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 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. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$Binding[];
/**
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
*/
etag?: string | null;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
version?: number | null;
}
/**
* Provider indicates the owner who provides the connectors.
*/
export interface Schema$Provider {
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Output only. Description of the resource.
*/
description?: string | null;
/**
* Output only. Display name.
*/
displayName?: string | null;
/**
* Output only. Link to documentation page.
*/
documentationUri?: string | null;
/**
* Output only. Link to external page.
*/
externalUri?: string | null;
/**
* Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. Flag to mark the version indicating the launch stage.
*/
launchStage?: string | null;
/**
* Output only. Resource name of the Provider. Format: projects/{project\}/locations/{location\}/providers/{provider\} Only global location is supported for Provider resource.
*/
name?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
/**
* Output only. Cloud storage location of icons etc consumed by UI.
*/
webAssetsLocation?: string | null;
}
/**
* Resource definition
*/
export interface Schema$Resource {
/**
* Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
*/
pathTemplate?: string | null;
/**
* Different types of resource supported.
*/
type?: string | null;
}
/**
* Metadata of result field.
*/
export interface Schema$ResultMetadata {
/**
* The data type of the field.
*/
dataType?: string | null;
/**
* A brief description of the field.
*/
description?: string | null;
/**
* Name of the result field.
*/
field?: string | null;
}
/**
* This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.
*/
export interface Schema$RoleGrant {
/**
* Template that UI can use to provide helper text to customers.
*/
helperTextTemplate?: string | null;
/**
* Prinicipal/Identity for whom the role need to assigned.
*/
principal?: string | null;
/**
* Resource on which the roles needs to be granted for the principal.
*/
resource?: Schema$Resource;
/**
* List of roles that need to be granted.
*/
roles?: string[] | null;
}
/**
* Schema of a runtime action.
*/
export interface Schema$RuntimeActionSchema {
/**
* Output only. Name of the action.
*/
action?: string | null;
/**
* Output only. List of input parameter metadata for the action.
*/
inputParameters?: Schema$InputParameter[];
/**
* Output only. List of result field metadata.
*/
resultMetadata?: Schema$ResultMetadata[];
}
/**
* RuntimeConfig is the singleton resource of each location. It includes generic resource configs consumed by control plane and runtime plane like: pub/sub topic/subscription resource name, Cloud Storage location storing schema etc.
*/
export interface Schema$RuntimeConfig {
/**
* Output only. Pub/Sub subscription for connd to receive message. E.g. projects/{project-id\}/subscriptions/{topic-id\}
*/
conndSubscription?: string | null;
/**
* Output only. Pub/Sub topic for connd to send message. E.g. projects/{project-id\}/topics/{topic-id\}
*/
conndTopic?: string | null;
/**
* Output only. Pub/Sub subscription for control plane to receive message. E.g. projects/{project-id\}/subscriptions/{topic-id\}
*/
controlPlaneSubscription?: string | null;
/**
* Output only. Pub/Sub topic for control plne to send message. communication. E.g. projects/{project-id\}/topics/{topic-id\}
*/
controlPlaneTopic?: string | null;
/**
* Output only. location_id of the runtime location. E.g. "us-west1".
*/
locationId?: string | null;
/**
* Output only. Name of the runtimeConfig resource. Format: projects/{project\}/locations/{location\}/runtimeConfig
*/
name?: string | null;
/**
* Output only. The endpoint of the connectors runtime ingress.
*/
runtimeEndpoint?: string | null;
/**
* Output only. The Cloud Storage bucket that stores connector's schema reports.
*/
schemaGcsBucket?: string | null;
/**
* Output only. The name of the Service Directory service name.
*/
serviceDirectory?: string | null;
/**
* Output only. The state of the location.
*/
state?: string | null;
}
/**
* Schema of a runtime entity.
*/
export interface Schema$RuntimeEntitySchema {
/**
* Output only. Name of the entity.
*/
entity?: string | null;
/**
* Output only. List of fields in the entity.
*/
fields?: Schema$Field[];
}
/**
* Secret provides a reference to entries in Secret Manager.
*/
export interface Schema$Secret {
/**
* The resource name of the secret version in the format, format as: `projects/x/secrets/x/versions/x`.
*/
secretVersion?: string | null;
}
/**
* Request message for `SetIamPolicy` method.
*/
export interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
*/
policy?: Schema$Policy;
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
*/
updateMask?: string | null;
}
/**
* Source to extract the backend from.
*/
export interface Schema$Source {
/**
* Field identifier. For example config vaiable name.
*/
fieldId?: string | null;
/**
* Type of the source.
*/
sourceType?: string | null;
}
/**
* Parameters to support Ssh public key Authentication.
*/
export interface Schema$SshPublicKey {
/**
* Format of SSH Client cert.
*/
certType?: string | null;
/**
* SSH Client Cert. It should contain both public and private key.
*/
sshClientCert?: Schema$Secret;
/**
* Password (passphrase) for ssh client certificate if it has one.
*/
sshClientCertPass?: Schema$Secret;
/**
* The user account used to authenticate.
*/
username?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environme