Sindbad~EG File Manager
/// <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[];
/**
* Identifier key for auth config
*/
authKey?: string | null;
/**
* The type of authentication configured.
*/
authType?: string | null;
/**
* Oauth2AuthCodeFlow.
*/
oauth2AuthCodeFlow?: Schema$Oauth2AuthCodeFlow;
/**
* 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 {
/**
* Identifier key for auth config
*/
authKey?: string | null;
/**
* The type of authentication configured.
*/
authType?: string | null;
/**
* Config variables to describe an `AuthConfig` for a `Connection`.
*/
configVariableTemplates?: Schema$ConfigVariableTemplate[];
/**
* Connector specific description for an authentication template.
*/
description?: string | null;
/**
* Display name for authentication template.
*/
displayName?: string | null;
}
/**
* 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 Google Cloud 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 Google Cloud 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`. * `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;
}
/**
* 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 a Encryption Key.
*/
encryptionKeyValue?: Schema$EncryptionKey;
/**
* 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[];
/**
* Indicates if current template is part of advanced settings
*/
isAdvanced?: boolean | null;
/**
* Key of the config variable.
*/
key?: string | null;
/**
* Optional. Location Tyep denotes where this value should be sent in BYOC connections.
*/
locationType?: string | null;
/**
* Flag represents that this `ConfigVariable` must be provided for a connection.
*/
required?: boolean | null;
/**
* Condition under which a field would be required. The condition can be represented in the form of a logical expression.
*/
requiredCondition?: Schema$LogicalExpression;
/**
* 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[];
/**
* Output only. Connection revision. This field is only updated when the connection is created or updated by User.
*/
connectionRevision?: string | null;
/**
* 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. Infra configs supported by Connector Version.
*/
connectorVersionInfraConfig?: Schema$ConnectorVersionInfraConfig;
/**
* Output only. Flag to mark the version indicating the launch stage.
*/
connectorVersionLaunchStage?: 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;
/**
* Optional. Eventing config of a connection
*/
eventingConfig?: Schema$EventingConfig;
/**
* Optional. Eventing enablement type. Will be nil if eventing is not enabled.
*/
eventingEnablementType?: string | null;
/**
* Output only. Eventing Runtime Data.
*/
eventingRuntimeData?: Schema$EventingRuntimeData;
/**
* Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName\}/{imageName\}
*/
imageLocation?: string | null;
/**
* Output only. Is trusted tester program enabled for the project.
*/
isTrustedTester?: boolean | 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;
/**
* Optional. Log configuration for the connection.
*/
logConfig?: Schema$ConnectorsLogConfig;
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/{location\}/connections/{connection\}
*/
name?: string | null;
/**
* Optional. Node configuration for the connection.
*/
nodeConfig?: Schema$NodeConfig;
/**
* Optional. Service account needed for runtime plane to access Google Cloud 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;
/**
* Optional. Ssl config of a connection
*/
sslConfig?: Schema$SslConfig;
/**
* Output only. Current status of the connection.
*/
status?: Schema$ConnectionStatus;
/**
* Output only. This subscription type enum states the subscription type of the project.
*/
subscriptionType?: string | null;
/**
* 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;
/**
* Error message for users.
*/
errorMessage?: 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. Eventing details. Will be null if eventing is not supported.
*/
eventingDetails?: Schema$EventingDetails;
/**
* 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;
}
/**
* This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version
*/
export interface Schema$ConnectorInfraConfig {
/**
* The window used for ratelimiting runtime requests to connections.
*/
connectionRatelimitWindowSeconds?: string | null;
/**
* Indicate whether connector is deployed on GKE/CloudRun
*/
deploymentModel?: string | null;
/**
* HPA autoscaling config.
*/
hpaConfig?: Schema$HPAConfig;
/**
* Max QPS supported for internal requests originating from Connd.
*/
internalclientRatelimitThreshold?: string | null;
/**
* Max QPS supported by the connector version before throttling of requests.
*/
ratelimitThreshold?: string | null;
/**
* System resource limits.
*/
resourceLimits?: Schema$ResourceLimits;
/**
* System resource requests.
*/
resourceRequests?: Schema$ResourceRequests;
/**
* The name of shared connector deployment.
*/
sharedDeployment?: string | null;
}
/**
* Log configuration for the connection.
*/
export interface Schema$ConnectorsLogConfig {
/**
* Enabled represents whether logging is enabled or not for a connection.
*/
enabled?: boolean | 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. Infra configs supported by Connector.
*/
connectorInfraConfig?: Schema$ConnectorInfraConfig;
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Output only. List of destination configs needed to create a connection.
*/
destinationConfigTemplates?: Schema$DestinationConfigTemplate[];
/**
* Output only. Display name.
*/
displayName?: string | null;
/**
* Output only. Configuration for Egress Control.
*/
egressControlConfig?: Schema$EgressControlConfig;
/**
* Output only. Eventing configuration supported by the Connector.
*/
eventingConfigTemplate?: Schema$EventingConfigTemplate;
/**
* 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. Ssl configuration supported by the Connector.
*/
sslConfigTemplate?: Schema$SslConfigTemplate;
/**
* Output only. Information about the runtime features supported by the Connector.
*/
supportedRuntimeFeatures?: Schema$SupportedRuntimeFeatures;
/**
* Output only. Unsupported connection types.
*/
unsupportedConnectionTypes?: string[] | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version
*/
export interface Schema$ConnectorVersionInfraConfig {
/**
* Output only. The window used for ratelimiting runtime requests to connections.
*/
connectionRatelimitWindowSeconds?: string | null;
/**
* Optional. Indicates whether connector is deployed on GKE/CloudRun
*/
deploymentModel?: string | null;
/**
* Output only. HPA autoscaling config.
*/
hpaConfig?: Schema$HPAConfig;
/**
* Output only. Max QPS supported for internal requests originating from Connd.
*/
internalclientRatelimitThreshold?: string | null;
/**
* Output only. Max QPS supported by the connector version before throttling of requests.
*/
ratelimitThreshold?: string | null;
/**
* Output only. System resource limits.
*/
resourceLimits?: Schema$ResourceLimits;
/**
* Output only. System resource requests.
*/
resourceRequests?: Schema$ResourceRequests;
/**
* Output only. The name of shared connector deployment.
*/
sharedDeployment?: string | null;
}
/**
* CustomConnector represents the custom connector defined by the customer as part of byoc.
*/
export interface Schema$CustomConnector {
/**
* Optional. Active connector versions.
*/
activeConnectorVersions?: string[] | null;
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Required. Type of the custom connector.
*/
customConnectorType?: string | null;
/**
* Optional. Description of the resource.
*/
description?: string | null;
/**
* Optional. Display name.
*/
displayName?: 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. Logo of the resource.
*/
logo?: string | null;
/**
* Identifier. Resource name of the CustomConnector. Format: projects/{project\}/locations/{location\}/customConnectors/{connector\}
*/
name?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* CustomConnectorVersion indicates a specific version of a connector.
*/
export interface Schema$CustomConnectorVersion {
/**
* Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
*/
authConfig?: Schema$AuthConfig;
/**
* Optional. Backend variables config templates. This translates to additional variable templates in connection.
*/
backendVariableTemplates?: Schema$ConfigVariableTemplate[];
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.
*/
destinationConfigs?: Schema$DestinationConfig[];
/**
* Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.
*/
enableBackendDestinationConfig?: boolean | 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;
/**
* Output only. Identifier. Resource name of the Version. Format: projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}/customConnectorVersions/{custom_connector_version\}
*/
name?: string | null;
/**
* Optional. Service account used by runtime plane to access auth config secrets.
*/
serviceAccount?: string | null;
/**
* Optional. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`
*/
specLocation?: string | null;
/**
* Output only. State of the custom connector version.
*/
state?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* Time window specified for daily operations.
*/
export interface Schema$DailyCycle {
/**
* Output only. Duration of the time window, set by service producer.
*/
duration?: string | null;
/**
* Time within the day to start the operations.
*/
startTime?: Schema$TimeOfDay;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Dead Letter configuration details provided by the user.
*/
export interface Schema$DeadLetterConfig {
/**
* Optional. Project which has the topic given.
*/
projectId?: string | null;
/**
* Optional. Topic to push events which couldn't be processed.
*/
topic?: string | null;
}
/**
* DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.
*/
export interface Schema$DenyMaintenancePeriod {
/**
* Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end.
*/
endDate?: Schema$Date;
/**
* Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start.
*/
startDate?: Schema$Date;
/**
* Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC
*/
time?: Schema$TimeOfDay;
}
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;
}
/**
* DestinationConfigTemplate defines required destinations supported by the Connector.
*/
export interface Schema$DestinationConfigTemplate {
/**
* The default port.
*/
defaultPort?: number | null;
/**
* Description.
*/
description?: string | null;
/**
* Display name of the parameter.
*/
displayName?: string | null;
/**
* Whether the current destination tempalate is part of Advanced settings
*/
isAdvanced?: boolean | null;
/**
* Key of the destination.
*/
key?: string | null;
/**
* The maximum number of destinations supported for this key.
*/
max?: number | null;
/**
* The minimum number of destinations supported for this key.
*/
min?: number | null;
/**
* Whether port number should be provided by customers.
*/
portFieldType?: string | null;
/**
* Regex pattern for host.
*/
regexPattern?: 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 {
}
/**
* Regional encryption config for CMEK details.
*/
export interface Schema$EncryptionConfig {
/**
* Optional. Encryption type for the region.
*/
encryptionType?: string | null;
/**
* Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/ {crypto_key\}`
*/
kmsKeyName?: string | null;
}
/**
* Encryption Key value.
*/
export interface Schema$EncryptionKey {
/**
* The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/x/locations/x/keyRings/x/cryptoKeys/x`. Will be empty string if google managed.
*/
kmsKeyName?: string | null;
/**
* Type.
*/
type?: string | null;
}
/**
* Endpoint message includes details of the Destination endpoint.
*/
export interface Schema$EndPoint {
/**
* The URI of the Endpoint.
*/
endpointUri?: string | null;
/**
* List of Header to be added to the Endpoint.
*/
headers?: Schema$Header[];
}
/**
* represents the Connector's Endpoint Attachment resource
*/
export interface Schema$EndpointAttachment {
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Optional. Description of the resource.
*/
description?: string | null;
/**
* Output only. The Private Service Connect connection endpoint ip
*/
endpointIp?: 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;
/**
* Output only. Resource name of the Endpoint Attachment. Format: projects/{project\}/locations/{location\}/endpointAttachments/{endpoint_attachment\}
*/
name?: string | null;
/**
* Required. The path of the service attachment
*/
serviceAttachment?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* EnumOption definition
*/
export interface Schema$EnumOption {
/**
* Display name of the option.
*/
displayName?: string | null;
/**
* Id of the option.
*/
id?: string | null;
}
/**
* Eventing Configuration of a connection
*/
export interface Schema$EventingConfig {
/**
* Additional eventing related field values
*/
additionalVariables?: Schema$ConfigVariable[];
/**
* Auth details for the webhook adapter.
*/
authConfig?: Schema$AuthConfig;
/**
* Optional. Dead letter configuration for eventing of a connection.
*/
deadLetterConfig?: Schema$DeadLetterConfig;
/**
* Enrichment Enabled.
*/
enrichmentEnabled?: boolean | null;
/**
* Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
*/
eventsListenerIngressEndpoint?: string | null;
/**
* Optional. Auth details for the event listener.
*/
listenerAuthConfig?: Schema$AuthConfig;
/**
* Optional. Private Connectivity Enabled.
*/
privateConnectivityEnabled?: boolean | null;
/**
* Optional. Proxy for Eventing auto-registration.
*/
proxyDestinationConfig?: Schema$DestinationConfig;
/**
* Registration endpoint for auto registration.
*/
registrationDestinationConfig?: Schema$DestinationConfig;
/**
* Optional. Additional eventing related field values
*/
triggerConfigVariables?: Schema$ConfigVariable[];
}
/**
* Eventing Config details of a connector version.
*/
export interface Schema$EventingConfigTemplate {
/**
* Additional fields that need to be rendered.
*/
additionalVariables?: Schema$ConfigVariableTemplate[];
/**
* AuthConfigTemplates represents the auth values for the webhook adapter.
*/
authConfigTemplates?: Schema$AuthConfigTemplate[];
/**
* Auto refresh to extend webhook life.
*/
autoRefresh?: boolean | null;
/**
* Auto Registration supported.
*/
autoRegistrationSupported?: boolean | null;
/**
* Encryption key (can be either Google managed or CMEK).
*/
encryptionKeyTemplate?: Schema$ConfigVariableTemplate;
/**
* Enrichment Supported.
*/
enrichmentSupported?: boolean | null;
/**
* The type of the event listener for a specific connector.
*/
eventListenerType?: string | null;
/**
* Is Eventing Supported.
*/
isEventingSupported?: boolean | null;
/**
* ListenerAuthConfigTemplates represents the auth values for the event listener.
*/
listenerAuthConfigTemplates?: Schema$AuthConfigTemplate[];
/**
* Proxy destination config template.
*/
proxyDestinationConfig?: Schema$DestinationConfigTemplate;
/**
* Registration host destination config template.
*/
registrationDestinationConfig?: Schema$DestinationConfigTemplate;
/**
* Trigger Config fields that needs to be rendered
*/
triggerConfigVariables?: Schema$ConfigVariableTemplate[];
}
/**
* Eventing Details message.
*/
export interface Schema$EventingDetails {
/**
* Output only. Custom Event Types.
*/
customEventTypes?: boolean | null;
/**
* Output only. Description.
*/
description?: string | null;
/**
* Output only. Link to public documentation.
*/
documentationLink?: string | null;
/**
* Output only. Cloud storage location of the icon.
*/
iconLocation?: string | null;
/**
* Output only. Eventing Launch Stage.
*/
launchStage?: string | null;
/**
* Output only. Name of the Eventing trigger.
*/
name?: string | null;
/**
* Output only. Array of search keywords.
*/
searchTags?: string[] | null;
/**
* Output only. The type of the event listener for a specific connector.
*/
type?: string | null;
}
/**
* Eventing runtime data has the details related to eventing managed by the system.
*/
export interface Schema$EventingRuntimeData {
/**
* Output only. Events listener endpoint. The value will populated after provisioning the events listener.
*/
eventsListenerEndpoint?: string | null;
/**
* Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
*/
eventsListenerPscSa?: string | null;
/**
* Output only. Current status of eventing.
*/
status?: Schema$EventingStatus;
}
/**
* EventingStatus indicates the state of eventing.
*/
export interface Schema$EventingStatus {
/**
* Output only. Description of error if State is set to "ERROR".
*/
description?: string | null;
/**
* Output only. State.
*/
state?: string | null;
}
/**
* represents the Connector's EventSubscription resource
*/
export interface Schema$EventSubscription {
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Optional. The destination to hit when we receive an event
*/
destinations?: Schema$EventSubscriptionDestination;
/**
* Optional. Event type id of the event of current EventSubscription.
*/
eventTypeId?: string | null;
/**
* Optional. JMS is the source for the event listener.
*/
jms?: Schema$JMS;
/**
* Required. Resource name of the EventSubscription. Format: projects/{project\}/locations/{location\}/connections/{connection\}/eventSubscriptions/{event_subscription\}
*/
name?: string | null;
/**
* Optional. Status indicates the status of the event subscription resource
*/
status?: Schema$EventSubscriptionStatus;
/**
* Optional. name of the Subscriber for the current EventSubscription.
*/
subscriber?: string | null;
/**
* Optional. Link for Subscriber of the current EventSubscription.
*/
subscriberLink?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* Message for EventSubscription Destination to act on receiving an event
*/
export interface Schema$EventSubscriptionDestination {
/**
* OPTION 1: Hit an endpoint when we receive an event.
*/
endpoint?: Schema$EndPoint;
/**
* Service account needed for runtime plane to trigger IP workflow.
*/
serviceAccount?: string | null;
/**
* type of the destination
*/
type?: string | null;
}
/**
* EventSubscription Status denotes the status of the EventSubscription resource.
*/
export interface Schema$EventSubscriptionStatus {
/**
* Output only. Description of the state.
*/
description?: string | null;
/**
* Output only. State of Event Subscription resource.
*/
state?: string | null;
}
/**
* EventType includes fields.
*/
export interface Schema$EventType {
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
*/
enrichedEventPayloadSchema?: string | null;
/**
* Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
*/
entityType?: string | null;
/**
* Output only. Schema of webhook event payload.
*/
eventPayloadSchema?: string | null;
/**
* Output only. Event type id. Example: `ticket.created`.
*/
eventTypeId?: string | null;
/**
* Output only. Id path denotes the path of id in webhook payload.
*/
idPath?: string | null;
/**
* Output only. Resource name of the eventtype. Format: projects/{project\}/locations/{location\}/providers/{provider\}/connectors/{connector\}/versions/{version\}/eventtypes/{eventtype\} Only global location is supported for Connector resource.
*/
name?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: 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;
/**
* JsonSchema representation of this entity's schema
*/
jsonSchema?: Schema$JsonSchema;
/**
* 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;
}
/**
* Field that needs to be compared.
*/
export interface Schema$FieldComparison {
/**
* Boolean value
*/
boolValue?: boolean | null;
/**
* Comparator to use for comparing the field value.
*/
comparator?: string | null;
/**
* Integer value
*/
intValue?: string | null;
/**
* Key of the field.
*/
key?: string | null;
/**
* String value
*/
stringValue?: string | null;
}
/**
* Header details for a given header to be added to Endpoint.
*/
export interface Schema$Header {
/**
* Key of Header.
*/
key?: string | null;
/**
* Value of Header.
*/
value?: string | null;
}
/**
* Autoscaling config for connector deployment system metrics.
*/
export interface Schema$HPAConfig {
/**
* Output only. Percent CPU utilization where HPA triggers autoscaling.
*/
cpuUtilizationThreshold?: string | null;
/**
* Output only. Percent Memory utilization where HPA triggers autoscaling.
*/
memoryUtilizationThreshold?: string | 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;
/**
* JsonSchema representation of this action's parameter
*/
jsonSchema?: Schema$JsonSchema;
/**
* Specifies whether a null value is allowed.
*/
nullable?: boolean | null;
/**
* Name of the Parameter.
*/
parameter?: string | null;
}
/**
* Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, \}, "labels": { "env": "prod", "foo": "bar" \}, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", \}, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", \} "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", \}, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", \} ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \}, "ncsa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \} \}, "consumer_defined_name": "my-sql-instance1", \} ``` LINT.IfChange
*/
export interface Schema$Instance {
/**
* consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).
*/
consumerDefinedName?: string | null;
/**
* Output only. Timestamp when the resource was created.
*/
createTime?: string | null;
/**
* Optional. The instance_type of this instance of format: projects/{project_number\}/locations/{location_id\}/instanceTypes/{instance_type_id\}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not.
*/
instanceType?: string | null;
/**
* Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_settings.maintenance_policies is set.
*/
maintenancePolicyNames?: {
[key: string]: string;
} | null;
/**
* The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.
*/
maintenanceSchedules?: {
[key: string]: Schema$MaintenanceSchedule;
} | null;
/**
* Optional. The MaintenanceSettings associated with instance.
*/
maintenanceSettings?: Schema$MaintenanceSettings;
/**
* Unique name of the resource. It uses the form: `projects/{project_number\}/locations/{location_id\}/instances/{instance_id\}` Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details.
*/
name?: string | null;
/**
* Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose.
*/
notificationParameters?: {
[key: string]: Schema$NotificationParameter;
} | null;
/**
* Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.
*/
producerMetadata?: {
[key: string]: string;
} | null;
/**
* Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.
*/
provisionedResources?: Schema$ProvisionedResource[];
/**
* Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.
*/
slmInstanceTemplate?: string | null;
/**
* Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.
*/
sloMetadata?: Schema$SloMetadata;
/**
* Software versions that are used to deploy this instance. This can be mutated by rollout services.
*/
softwareVersions?: {
[key: string]: string;
} | null;
/**
* Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).
*/
state?: string | null;
/**
* Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.
*/
tenantProjectId?: string | null;
/**
* Output only. Timestamp when the resource was last modified.
*/
updateTime?: string | null;
}
/**
* JMS message denotes the source of the event
*/
export interface Schema$JMS {
/**
* Optional. Name of the JMS source. i.e. queueName or topicName
*/
name?: string | null;
/**
* Optional. Type of the JMS Source. i.e. Queue or Topic
*/
type?: string | null;
}
/**
* JsonSchema representation of schema metadata
*/
export interface Schema$JsonSchema {
/**
* The default value of the field or object described by this schema.
*/
default?: any | null;
/**
* A description of this schema.
*/
description?: string | null;
/**
* Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
*/
enum?: any[] | null;
/**
* Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
*/
format?: string | null;
/**
* Schema that applies to array values, applicable only if this is of type `array`.
*/
items?: Schema$JsonSchema;
/**
* JDBC datatype of the field.
*/
jdbcType?: string | null;
/**
* The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
*/
properties?: {
[key: string]: Schema$JsonSchema;
} | null;
/**
* Whether this property is required.
*/
required?: string[] | null;
/**
* JSON Schema Validation: A Vocabulary for Structural Validation of JSON
*/
type?: 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 ListActions API
*/
export interface Schema$ListActionsResponse {
/**
* list of actions
*/
actions?: Schema$RuntimeActionSchema[];
/**
* token for next page
*/
nextPageToken?: 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;
}
/**
* Response message for Connectors.ListCustomConnectors.
*/
export interface Schema$ListCustomConnectorsResponse {
/**
* A list of customConnectors.
*/
customConnectors?: Schema$CustomConnector[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for Connectors.ListCustomConnectorVersions.
*/
export interface Schema$ListCustomConnectorVersionsResponse {
/**
* A list of connector versions.
*/
customConnectorVersions?: Schema$CustomConnectorVersion[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for ConnectorsService.ListEndpointAttachments
*/
export interface Schema$ListEndpointAttachmentsResponse {
/**
* EndpointAttachments.
*/
endpointAttachments?: Schema$EndpointAttachment[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Expected request for ListenEvent API.
*/
export interface Schema$ListenEventRequest {
/**
* Optional. Request payload.
*/
payload?: {
[key: string]: any;
} | null;
}
/**
* Expected response for ListenEvent API.
*/
export interface Schema$ListenEventResponse {
}
/**
* Response message for ListEntityTypes API
*/
export interface Schema$ListEntityTypesResponse {
/**
* list of entity types
*/
entityTypes?: Schema$RuntimeEntitySchema[];
/**
* token for next page
*/
nextPageToken?: string | null;
}
/**
* Response message for ConnectorsService.ListEventSubscriptions
*/
export interface Schema$ListEventSubscriptionsResponse {
/**
* Subscriptions.
*/
eventSubscriptions?: Schema$EventSubscription[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* Response message for Connectors.ListEventTypes.
*/
export interface Schema$ListEventTypesResponse {
/**
* A list of connector versions.
*/
eventTypes?: Schema$EventType[];
/**
* Next page token.
*/
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;
}
/**
* Response message for ConnectorsService.ListManagedZones
*/
export interface Schema$ListManagedZonesResponse {
/**
* ManagedZones.
*/
managedZones?: Schema$ManagedZone[];
/**
* 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 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;
}
/**
* 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;
}
/**
* Struct for representing boolean expressions.
*/
export interface Schema$LogicalExpression {
/**
* A list of fields to be compared.
*/
fieldComparisons?: Schema$FieldComparison[];
/**
* A list of nested conditions to be compared.
*/
logicalExpressions?: Schema$LogicalExpression[];
/**
* The logical operator to use between the fields and conditions.
*/
logicalOperator?: string | null;
}
/**
* LINT.IfChange Defines policies to service maintenance events.
*/
export interface Schema$MaintenancePolicy {
/**
* Output only. The time when the resource was created.
*/
createTime?: string | null;
/**
* Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.
*/
description?: string | null;
/**
* Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. MaintenancePolicy name using the form: `projects/{project_id\}/locations/{location_id\}/maintenancePolicies/{maintenance_policy_id\}` where {project_id\} refers to a GCP consumer project ID, {location_id\} refers to a GCP region/zone, {maintenance_policy_id\} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.
*/
name?: string | null;
/**
* Optional. The state of the policy.
*/
state?: string | null;
/**
* Maintenance policy applicable to instance update.
*/
updatePolicy?: Schema$UpdatePolicy;
/**
* Output only. The time when the resource was updated.
*/
updateTime?: string | null;
}
/**
* Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule
*/
export interface Schema$MaintenanceSchedule {
/**
* This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.
*/
canReschedule?: boolean | null;
/**
* The scheduled end time for the maintenance.
*/
endTime?: string | null;
/**
* The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.
*/
rolloutManagementPolicy?: string | null;
/**
* schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus maintenance window length (1 day or 1 week). Maintenance cannot be scheduled to start beyond this deadline.
*/
scheduleDeadlineTime?: string | null;
/**
* The scheduled start time for the maintenance.
*/
startTime?: string | null;
}
/**
* Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.
*/
export interface Schema$MaintenanceSettings {
/**
* Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.
*/
exclude?: boolean | null;
/**
* Optional. If the update call is triggered from rollback, set the value as true.
*/
isRollback?: boolean | null;
/**
* Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_policy_names is set. If only the name is needed, then only populate MaintenancePolicy.name.
*/
maintenancePolicies?: {
[key: string]: Schema$MaintenancePolicy;
} | null;
}
/**
* MaintenanceWindow definition.
*/
export interface Schema$MaintenanceWindow {
/**
* Daily cycle.
*/
dailyCycle?: Schema$DailyCycle;
/**
* Weekly cycle.
*/
weeklyCycle?: Schema$WeeklyCycle;
}
/**
* represents the Connector's Managed Zone resource
*/
export interface Schema$ManagedZone {
/**
* Output only. Created time.
*/
createTime?: string | null;
/**
* Optional. Description of the resource.
*/
description?: string | null;
/**
* Required. DNS Name of the resource
*/
dns?: 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;
/**
* Output only. Resource name of the Managed Zone. Format: projects/{project\}/locations/global/managedZones/{managed_zone\}
*/
name?: string | null;
/**
* Required. The name of the Target Project
*/
targetProject?: string | null;
/**
* Required. The name of the Target Project VPC Network
*/
targetVpc?: string | null;
/**
* Output only. Updated time.
*/
updateTime?: string | null;
}
/**
* Regional Network Config.
*/
export interface Schema$NetworkConfig {
/**
* Output only. Egress IPs
*/
egressIps?: string[] | null;
/**
* Optional. Egress mode for the network.
*/
egressMode?: string | null;
}
/**
* Node 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;
}
/**
* Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.
*/
export interface Schema$NodeSloMetadata {
/**
* The location of the node, if different from instance location.
*/
location?: string | null;
/**
* The id of the node. This should be equal to SaasInstanceNode.node_id.
*/
nodeId?: string | null;
/**
* If present, this will override eligibility for the node coming from instance or exclusions for specified SLIs.
*/
perSliEligibility?: Schema$PerSliSloEligibility;
}
/**
* Contains notification related data.
*/
export interface Schema$NotificationParameter {
/**
* Optional. Array of string values. e.g. instance's replica information.
*/
values?: string[] | null;
}
/**
* Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.
*/
export interface Schema$Oauth2AuthCodeFlow {
/**
* Authorization code to be exchanged for access and refresh tokens.
*/
authCode?: string | null;
/**
* Auth URL for Authorization Code Flow
*/
authUri?: string | null;
/**
* Client ID for user-provided OAuth app.
*/
clientId?: string | null;
/**
* Client secret for user-provided OAuth app.
*/
clientSecret?: Schema$Secret;
/**
* Whether to enable PKCE when the user performs the auth code flow.
*/
enablePkce?: boolean | null;
/**
* PKCE verifier to be used during the auth code exchange.
*/
pkceVerifier?: string | null;
/**
* Redirect URI to be provided during the auth code exchange.
*/
redirectUri?: string | null;
/**
* Scopes the connection will request when the user performs the auth code flow.
*/
scopes?: string[] | 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, 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 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;
}
/**
* PerSliSloEligibility is a mapping from an SLI name to eligibility.
*/
export interface Schema$PerSliSloEligibility {
/**
* An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.
*/
eligibilities?: {
[key: string]: Schema$SloEligibility;
} | 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;
}
/**
* Describes provisioned dataplane resources.
*/
export interface Schema$ProvisionedResource {
/**
* Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'.
*/
resourceType?: string | null;
/**
* URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/projects/...)".
*/
resourceUrl?: string | null;
}
/**
* Request message for ConnectorsService.RefreshConnectionSchemaMetadata.
*/
export interface Schema$RefreshConnectionSchemaMetadataRequest {
}
/**
* Regional Settings details.
*/
export interface Schema$RegionalSettings {
/**
* Optional. Regional encryption config to hold CMEK details.
*/
encryptionConfig?: Schema$EncryptionConfig;
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/{location\}/regionalSettings
*/
name?: string | null;
/**
* Optional. Regional network config.
*/
networkConfig?: Schema$NetworkConfig;
/**
* Output only. Specifies whether the region is provisioned.
*/
provisioned?: boolean | null;
}
/**
* Request message for ConnectorsService.RepairEventing
*/
export interface Schema$RepairEventingRequest {
}
/**
* Resource definition
*/
export interface Schema$Resource {
/**
* Template to uniquely represent a Google Cloud 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;
}
/**
* Resource limits defined for connection pods of a given connector type.
*/
export interface Schema$ResourceLimits {
/**
* Output only. CPU limit.
*/
cpu?: string | null;
/**
* Output only. Memory limit.
*/
memory?: string | null;
}
/**
* Resource requests defined for connection pods of a given connector type.
*/
export interface Schema$ResourceRequests {
/**
* Output only. CPU request.
*/
cpu?: string | null;
/**
* Output only. Memory request.
*/
memory?: 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;
/**
* JsonSchema representation of this action's result
*/
jsonSchema?: Schema$JsonSchema;
}
/**
* Request message for ConnectorsService.RefreshEventSubscription
*/
export interface Schema$RetryEventSubscriptionRequest {
}
/**
* This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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. Brief Description of action
*/
description?: string | null;
/**
* Output only. Display Name of action to be shown on client side
*/
displayName?: string | null;
/**
* Output only. JsonSchema representation of this action's input metadata
*/
inputJsonSchema?: Schema$JsonSchema;
/**
* Output only. List of input parameter metadata for the action.
*/
inputParameters?: Schema$InputParameter[];
/**
* Output only. JsonSchema representation of this action's result metadata
*/
resultJsonSchema?: Schema$JsonSchema;
/**
* 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[];
/**
* Output only. JsonSchema representation of this entity's metadata
*/
jsonSchema?: Schema$JsonSchema;
}
/**
* Configure the schedule.
*/
export interface Schema$Schedule {
/**
* Allows to define schedule that runs specified day of the week.
*/
day?: string | null;
/**
* Output only. Duration of the time window, set by service producer.
*/
duration?: string | null;
/**
* Time within the window to start the operations.
*/
startTime?: Schema$TimeOfDay;
}
/**
* 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;
}
/**
* Global Settings details.
*/
export interface Schema$Settings {
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/global/settings\}
*/
name?: string | null;
/**
* Output only. Flag indicates if user is in PayG model
*/
payg?: boolean | null;
/**
* Output only. Tenant project id of the consumer project.
*/
tenantProjectId?: string | null;
/**
* Optional. Flag indicates whether vpc-sc is enabled.
*/
vpcsc?: boolean | null;
}
/**
* SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.
*/
export interface Schema$SloEligibility {
/**
* Whether an instance is eligible or ineligible.
*/
eligible?: boolean | null;
/**
* User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.
*/
reason?: string | null;
}
/**
* SloMetadata contains resources required for proper SLO classification of the instance.
*/
export interface Schema$SloMetadata {
/**
* Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch.
*/
nodes?: Schema$NodeSloMetadata[];
/**
* Optional. Multiple per-instance SLI eligibilities which apply for individual SLIs.
*/
perSliEligibility?: Schema$PerSliSloEligibility;
/**
* Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty.
*/
tier?: 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;
}
/**
* SSL Configuration of a connection
*/
export interface Schema$SslConfig {
/**
* Additional SSL related field values
*/
additionalVariables?: Schema$ConfigVariable[];
/**
* Client Certificate
*/
clientCertificate?: Schema$Secret;
/**
* Type of Client Cert (PEM/JKS/.. etc.)
*/
clientCertType?: string | null;
/**
* Client Private Key
*/
clientPrivateKey?: Schema$Secret;
/**
* Secret containing the passphrase protecting the Client Private Key
*/
clientPrivateKeyPass?: Schema$Secret;
/**
* Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
*/
privateServerCertificate?: Schema$Secret;
/**
* Type of Server Cert (PEM/JKS/.. etc.)
*/
serverCertType?: string | null;
/**
* Trust Model of the SSL connection
*/
trustModel?: string | null;
/**
* Controls the ssl type for the given connector version.
*/
type?: string | null;
/**
* Bool for enabling SSL
*/
useSsl?: boolean | null;
}
/**
* Ssl config details of a connector version
*/
export interface Schema$SslConfigTemplate {
/**
* Any additional fields that need to be rendered
*/
additionalVariables?: Schema$ConfigVariableTemplate[];
/**
* List of supported Client Cert Types
*/
clientCertType?: string[] | null;
/**
* Boolean for determining if the connector version mandates TLS.
*/
isTlsMandatory?: boolean | null;
/**
* List of supported Server Cert Types
*/
serverCertType?: string[] | null;
/**
* Controls the ssl type for the given connector version
*/
sslType?: string | null;
}
/**
* 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;
}
/**
* Supported runtime features of a connector version.
*/
export interface Schema$SupportedRuntimeFeatures {
/**
* Specifies if the connector supports action apis like 'executeAction'.
*/
actionApis?: boolean | null;
/**
* Specifies if the connector supports entity apis like 'createEntity'.
*/
entityApis?: boolean | null;
/**
* Specifies if the connector supports 'ExecuteSqlQuery' operation.
*/
sqlQuery?: boolean | null;
}
/**
* Request message for `TestIamPermissions` method.
*/
export interface Schema$TestIamPermissionsRequest {
/**
* The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
permissions?: string[] | null;
}
/**
* Response message for `TestIamPermissions` method.
*/
export interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
*/
permissions?: string[] | null;
}
/**
* Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
export interface Schema$TimeOfDay {
/**
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
*/
hours?: number | null;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number | null;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number | null;
/**
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
*/
seconds?: number | null;
}
/**
* Maintenance policy applicable to instance updates.
*/
export interface Schema$UpdatePolicy {
/**
* Optional. Relative scheduling channel applied to resource.
*/
channel?: string | null;
/**
* Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. The protocol supports zero-to-many such periods, but the current SLM Rollout implementation only supports zero-to-one.
*/
denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[];
/**
* Optional. Maintenance window that is applied to resources covered by this policy.
*/
window?: Schema$MaintenanceWindow;
}
/**
* Parameters to support Username and Password Authentication.
*/
export interface Schema$UserPassword {
/**
* Secret version reference containing the password.
*/
password?: Schema$Secret;
/**
* Username.
*/
username?: string | null;
}
/**
* Time window specified for weekly operations.
*/
export interface Schema$WeeklyCycle {
/**
* User can specify multiple windows in a week. Minimum of 1 window.
*/
schedule?: Schema$Schedule[];
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations {
context: APIRequestContext;
connections: Resource$Projects$Locations$Connections;
endpointAttachments: Resource$Projects$Locations$Endpointattachments;
global: Resource$Projects$Locations$Global;
operations: Resource$Projects$Locations$Operations;
providers: Resource$Projects$Locations$Providers;
constructor(context: APIRequestContext);
/**
* Gets information about a location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): GaxiosPromise<Schema$Location>;
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
get(callback: BodyResponseCallback<Schema$Location>): void;
/**
* GetRegionalSettings gets settings of a region. RegionalSettings is a singleton resource.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getRegionalSettings(params: Params$Resource$Projects$Locations$Getregionalsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
getRegionalSettings(params?: Params$Resource$Projects$Locations$Getregionalsettings, options?: MethodOptions): GaxiosPromise<Schema$RegionalSettings>;
getRegionalSettings(params: Params$Resource$Projects$Locations$Getregionalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getRegionalSettings(params: Params$Resource$Projects$Locations$Getregionalsettings, options: MethodOptions | BodyResponseCallback<Schema$RegionalSettings>, callback: BodyResponseCallback<Schema$RegionalSettings>): void;
getRegionalSettings(params: Params$Resource$Projects$Locations$Getregionalsettings, callback: BodyResponseCallback<Schema$RegionalSettings>): void;
getRegionalSettings(callback: BodyResponseCallback<Schema$RegionalSettings>): void;
/**
* Gets the runtimeConfig of a location. RuntimeConfig is a singleton resource for each location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getRuntimeConfig(params: Params$Resource$Projects$Locations$Getruntimeconfig, options: StreamMethodOptions): GaxiosPromise<Readable>;
getRuntimeConfig(params?: Params$Resource$Projects$Locations$Getruntimeconfig, options?: MethodOptions): GaxiosPromise<Schema$RuntimeConfig>;
getRuntimeConfig(params: Params$Resource$Projects$Locations$Getruntimeconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getRuntimeConfig(params: Params$Resource$Projects$Locations$Getruntimeconfig, options: MethodOptions | BodyResponseCallback<Schema$RuntimeConfig>, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
getRuntimeConfig(params: Params$Resource$Projects$Locations$Getruntimeconfig, callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
getRuntimeConfig(callback: BodyResponseCallback<Schema$RuntimeConfig>): void;
/**
* Lists information about the supported locations for this service.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): GaxiosPromise<Schema$ListLocationsResponse>;
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
/**
* Update the settings of a region.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateRegionalSettings(params: Params$Resource$Projects$Locations$Updateregionalsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
updateRegionalSettings(params?: Params$Resource$Projects$Locations$Updateregionalsettings, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
updateRegionalSettings(params: Params$Resource$Projects$Locations$Updateregionalsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateRegionalSettings(params: Params$Resource$Projects$Locations$Updateregionalsettings, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
updateRegionalSettings(params: Params$Resource$Projects$Locations$Updateregionalsettings, callback: BodyResponseCallback<Schema$Operation>): void;
updateRegionalSettings(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Get extends StandardParameters {
/**
* Resource name for the location.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Getregionalsettings extends StandardParameters {
/**
* Required. The resource name of the Regional Settings.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Getruntimeconfig extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/runtimeConfig`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
/**
* A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
*/
filter?: string;
/**
* The resource that owns the locations collection, if applicable.
*/
name?: string;
/**
* The maximum number of results to return. If not set, the service selects a default.
*/
pageSize?: number;
/**
* A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
*/
pageToken?: string;
}
export interface Params$Resource$Projects$Locations$Updateregionalsettings extends StandardParameters {
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/{location\}/regionalSettings
*/
name?: string;
/**
* Required. The list of fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RegionalSettings;
}
export class Resource$Projects$Locations$Connections {
context: APIRequestContext;
connectionSchemaMetadata: Resource$Projects$Locations$Connections$Connectionschemametadata;
eventSubscriptions: Resource$Projects$Locations$Connections$Eventsubscriptions;
runtimeActionSchemas: Resource$Projects$Locations$Connections$Runtimeactionschemas;
runtimeEntitySchemas: Resource$Projects$Locations$Connections$Runtimeentityschemas;
constructor(context: APIRequestContext);
/**
* Creates a new Connection in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Connections$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Connections$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Connections$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Connections$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Connections$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a single Connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Connections$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Connections$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Connections$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Connections$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Connections$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Gets details of a single Connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Connections$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Connections$Get, options?: MethodOptions): GaxiosPromise<Schema$Connection>;
get(params: Params$Resource$Projects$Locations$Connections$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Connections$Get, options: MethodOptions | BodyResponseCallback<Schema$Connection>, callback: BodyResponseCallback<Schema$Connection>): void;
get(params: Params$Resource$Projects$Locations$Connections$Get, callback: BodyResponseCallback<Schema$Connection>): void;
get(callback: BodyResponseCallback<Schema$Connection>): void;
/**
* Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getConnectionSchemaMetadata(params: Params$Resource$Projects$Locations$Connections$Getconnectionschemametadata, options: StreamMethodOptions): GaxiosPromise<Readable>;
getConnectionSchemaMetadata(params?: Params$Resource$Projects$Locations$Connections$Getconnectionschemametadata, options?: MethodOptions): GaxiosPromise<Schema$ConnectionSchemaMetadata>;
getConnectionSchemaMetadata(params: Params$Resource$Projects$Locations$Connections$Getconnectionschemametadata, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getConnectionSchemaMetadata(params: Params$Resource$Projects$Locations$Connections$Getconnectionschemametadata, options: MethodOptions | BodyResponseCallback<Schema$ConnectionSchemaMetadata>, callback: BodyResponseCallback<Schema$ConnectionSchemaMetadata>): void;
getConnectionSchemaMetadata(params: Params$Resource$Projects$Locations$Connections$Getconnectionschemametadata, callback: BodyResponseCallback<Schema$ConnectionSchemaMetadata>): void;
getConnectionSchemaMetadata(callback: BodyResponseCallback<Schema$ConnectionSchemaMetadata>): void;
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getIamPolicy(params: Params$Resource$Projects$Locations$Connections$Getiampolicy, options: StreamMethodOptions): GaxiosPromise<Readable>;
getIamPolicy(params?: Params$Resource$Projects$Locations$Connections$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Locations$Connections$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getIamPolicy(params: Params$Resource$Projects$Locations$Connections$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Locations$Connections$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* Lists Connections in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Connections$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Connections$List, options?: MethodOptions): GaxiosPromise<Schema$ListConnectionsResponse>;
list(params: Params$Resource$Projects$Locations$Connections$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Connections$List, options: MethodOptions | BodyResponseCallback<Schema$ListConnectionsResponse>, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(params: Params$Resource$Projects$Locations$Connections$List, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
/**
* ListenEvent listens to the event.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listenEvent(params: Params$Resource$Projects$Locations$Connections$Listenevent, options: StreamMethodOptions): GaxiosPromise<Readable>;
listenEvent(params?: Params$Resource$Projects$Locations$Connections$Listenevent, options?: MethodOptions): GaxiosPromise<Schema$ListenEventResponse>;
listenEvent(params: Params$Resource$Projects$Locations$Connections$Listenevent, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listenEvent(params: Params$Resource$Projects$Locations$Connections$Listenevent, options: MethodOptions | BodyResponseCallback<Schema$ListenEventResponse>, callback: BodyResponseCallback<Schema$ListenEventResponse>): void;
listenEvent(params: Params$Resource$Projects$Locations$Connections$Listenevent, callback: BodyResponseCallback<Schema$ListenEventResponse>): void;
listenEvent(callback: BodyResponseCallback<Schema$ListenEventResponse>): void;
/**
* Updates the parameters of a single Connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Connections$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Connections$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Connections$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Connections$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Connections$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* RepaiEventing tries to repair eventing related event subscriptions.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
repairEventing(params: Params$Resource$Projects$Locations$Connections$Repaireventing, options: StreamMethodOptions): GaxiosPromise<Readable>;
repairEventing(params?: Params$Resource$Projects$Locations$Connections$Repaireventing, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
repairEventing(params: Params$Resource$Projects$Locations$Connections$Repaireventing, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
repairEventing(params: Params$Resource$Projects$Locations$Connections$Repaireventing, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
repairEventing(params: Params$Resource$Projects$Locations$Connections$Repaireventing, callback: BodyResponseCallback<Schema$Operation>): void;
repairEventing(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
setIamPolicy(params: Params$Resource$Projects$Locations$Connections$Setiampolicy, options: StreamMethodOptions): GaxiosPromise<Readable>;
setIamPolicy(params?: Params$Resource$Projects$Locations$Connections$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Locations$Connections$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
setIamPolicy(params: Params$Resource$Projects$Locations$Connections$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Locations$Connections$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
testIamPermissions(params: Params$Resource$Projects$Locations$Connections$Testiampermissions, options: StreamMethodOptions): GaxiosPromise<Readable>;
testIamPermissions(params?: Params$Resource$Projects$Locations$Connections$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Locations$Connections$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
testIamPermissions(params: Params$Resource$Projects$Locations$Connections$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Locations$Connections$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Connections$Create extends StandardParameters {
/**
* Required. Identifier to assign to the Connection. Must be unique within scope of the parent resource.
*/
connectionId?: string;
/**
* Required. Parent resource of the Connection, of the form: `projects/x/locations/x`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Connection;
}
export interface Params$Resource$Projects$Locations$Connections$Delete extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/connections/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/connections/x`
*/
name?: string;
/**
* Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view.
*/
view?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Getconnectionschemametadata extends StandardParameters {
/**
* Required. Connection name Format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Getiampolicy extends StandardParameters {
/**
* 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).
*/
'options.requestedPolicyVersion'?: number;
/**
* REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
*/
resource?: string;
}
export interface Params$Resource$Projects$Locations$Connections$List extends StandardParameters {
/**
* Filter.
*/
filter?: string;
/**
* Order by parameters.
*/
orderBy?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the Connection, of the form: `projects/x/locations/x`
*/
parent?: string;
/**
* Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view.
*/
view?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Listenevent extends StandardParameters {
/**
* Required. Resource path for request.
*/
resourcePath?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ListenEventRequest;
}
export interface Params$Resource$Projects$Locations$Connections$Patch extends StandardParameters {
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/{location\}/connections/{connection\}
*/
name?: string;
/**
* Required. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config` * `log_config` * `ssl_config` * `eventing_enablement_type` * `eventing_config`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Connection;
}
export interface Params$Resource$Projects$Locations$Connections$Repaireventing extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/connections/x`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RepairEventingRequest;
}
export interface Params$Resource$Projects$Locations$Connections$Setiampolicy extends StandardParameters {
/**
* REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
export interface Params$Resource$Projects$Locations$Connections$Testiampermissions extends StandardParameters {
/**
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
export class Resource$Projects$Locations$Connections$Connectionschemametadata {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get action.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAction(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, options: StreamMethodOptions): GaxiosPromise<Readable>;
getAction(params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
getAction(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAction(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
getAction(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, callback: BodyResponseCallback<Schema$Operation>): void;
getAction(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Get entity type.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getEntityType(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, options: StreamMethodOptions): GaxiosPromise<Readable>;
getEntityType(params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
getEntityType(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getEntityType(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
getEntityType(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, callback: BodyResponseCallback<Schema$Operation>): void;
getEntityType(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* List actions.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listActions(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, options: StreamMethodOptions): GaxiosPromise<Readable>;
listActions(params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, options?: MethodOptions): GaxiosPromise<Schema$ListActionsResponse>;
listActions(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listActions(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, options: MethodOptions | BodyResponseCallback<Schema$ListActionsResponse>, callback: BodyResponseCallback<Schema$ListActionsResponse>): void;
listActions(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, callback: BodyResponseCallback<Schema$ListActionsResponse>): void;
listActions(callback: BodyResponseCallback<Schema$ListActionsResponse>): void;
/**
* List entity types.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
listEntityTypes(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, options: StreamMethodOptions): GaxiosPromise<Readable>;
listEntityTypes(params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, options?: MethodOptions): GaxiosPromise<Schema$ListEntityTypesResponse>;
listEntityTypes(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
listEntityTypes(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, options: MethodOptions | BodyResponseCallback<Schema$ListEntityTypesResponse>, callback: BodyResponseCallback<Schema$ListEntityTypesResponse>): void;
listEntityTypes(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, callback: BodyResponseCallback<Schema$ListEntityTypesResponse>): void;
listEntityTypes(callback: BodyResponseCallback<Schema$ListEntityTypesResponse>): void;
/**
* Refresh runtime schema of a connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
refresh(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, options: StreamMethodOptions): GaxiosPromise<Readable>;
refresh(params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
refresh(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
refresh(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
refresh(params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, callback: BodyResponseCallback<Schema$Operation>): void;
refresh(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction extends StandardParameters {
/**
* Required. Id of the action.
*/
actionId?: string;
/**
* Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype extends StandardParameters {
/**
* Required. Id of the entity type.
*/
entityId?: string;
/**
* Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions extends StandardParameters {
/**
* Required. Filter Wildcards are not supported in the filter currently.
*/
filter?: string;
/**
* Required. Resource name format. projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string;
/**
* Page size. If unspecified, at most 50 actions will be returned.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Specifies which fields are returned in response. Defaults to BASIC view.
*/
view?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes extends StandardParameters {
/**
* Required. Filter Wildcards are not supported in the filter currently.
*/
filter?: string;
/**
* Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string;
/**
* Page size. If unspecified, at most 50 entity types will be returned.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Specifies which fields are returned in response. Defaults to BASIC view.
*/
view?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh extends StandardParameters {
/**
* Required. Resource name. Format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RefreshConnectionSchemaMetadataRequest;
}
export class Resource$Projects$Locations$Connections$Eventsubscriptions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new EventSubscription in a given project,location and connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a single EventSubscription.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Gets details of a single EventSubscription.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Get, options?: MethodOptions): GaxiosPromise<Schema$EventSubscription>;
get(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Get, options: MethodOptions | BodyResponseCallback<Schema$EventSubscription>, callback: BodyResponseCallback<Schema$EventSubscription>): void;
get(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Get, callback: BodyResponseCallback<Schema$EventSubscription>): void;
get(callback: BodyResponseCallback<Schema$EventSubscription>): void;
/**
* List EventSubscriptions in a given project,location and connection.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$List, options?: MethodOptions): GaxiosPromise<Schema$ListEventSubscriptionsResponse>;
list(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$List, options: MethodOptions | BodyResponseCallback<Schema$ListEventSubscriptionsResponse>, callback: BodyResponseCallback<Schema$ListEventSubscriptionsResponse>): void;
list(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$List, callback: BodyResponseCallback<Schema$ListEventSubscriptionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListEventSubscriptionsResponse>): void;
/**
* Updates the parameters of a single EventSubscription.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* RetryEventSubscription retries the registration of Subscription.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
retry(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Retry, options: StreamMethodOptions): GaxiosPromise<Readable>;
retry(params?: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Retry, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
retry(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Retry, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
retry(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Retry, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
retry(params: Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Retry, callback: BodyResponseCallback<Schema$Operation>): void;
retry(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Create extends StandardParameters {
/**
* Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
*/
eventSubscriptionId?: string;
/**
* Required. Parent resource of the EventSubscription, of the form: `projects/x/locations/x/connections/x`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EventSubscription;
}
export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Delete extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/connections/x/eventsubscriptions/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/connections/x/eventSubscriptions/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$List extends StandardParameters {
/**
* Filter.
*/
filter?: string;
/**
* Order by parameters.
*/
orderBy?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the EventSubscription, of the form: `projects/x/locations/x/connections/x`
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch extends StandardParameters {
/**
* Required. Resource name of the EventSubscription. Format: projects/{project\}/locations/{location\}/connections/{connection\}/eventSubscriptions/{event_subscription\}
*/
name?: string;
/**
* Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EventSubscription;
}
export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Retry extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/connections/x/eventSubscriptions/x`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$RetryEventSubscriptionRequest;
}
export class Resource$Projects$Locations$Connections$Runtimeactionschemas {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* List schema of a runtime actions filtered by action name.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Connections$Runtimeactionschemas$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Connections$Runtimeactionschemas$List, options?: MethodOptions): GaxiosPromise<Schema$ListRuntimeActionSchemasResponse>;
list(params: Params$Resource$Projects$Locations$Connections$Runtimeactionschemas$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Connections$Runtimeactionschemas$List, options: MethodOptions | BodyResponseCallback<Schema$ListRuntimeActionSchemasResponse>, callback: BodyResponseCallback<Schema$ListRuntimeActionSchemasResponse>): void;
list(params: Params$Resource$Projects$Locations$Connections$Runtimeactionschemas$List, callback: BodyResponseCallback<Schema$ListRuntimeActionSchemasResponse>): void;
list(callback: BodyResponseCallback<Schema$ListRuntimeActionSchemasResponse>): void;
}
export interface Params$Resource$Projects$Locations$Connections$Runtimeactionschemas$List extends StandardParameters {
/**
* Required. Filter Format: action="{actionId\}" Only action field is supported with literal equality operator. Accepted filter example: action="CancelOrder" Wildcards are not supported in the filter currently.
*/
filter?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of RuntimeActionSchema Format: projects/{project\}/locations/{location\}/connections/{connection\}
*/
parent?: string;
}
export class Resource$Projects$Locations$Connections$Runtimeentityschemas {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* List schema of a runtime entities filtered by entity name.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Connections$Runtimeentityschemas$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Connections$Runtimeentityschemas$List, options?: MethodOptions): GaxiosPromise<Schema$ListRuntimeEntitySchemasResponse>;
list(params: Params$Resource$Projects$Locations$Connections$Runtimeentityschemas$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Connections$Runtimeentityschemas$List, options: MethodOptions | BodyResponseCallback<Schema$ListRuntimeEntitySchemasResponse>, callback: BodyResponseCallback<Schema$ListRuntimeEntitySchemasResponse>): void;
list(params: Params$Resource$Projects$Locations$Connections$Runtimeentityschemas$List, callback: BodyResponseCallback<Schema$ListRuntimeEntitySchemasResponse>): void;
list(callback: BodyResponseCallback<Schema$ListRuntimeEntitySchemasResponse>): void;
}
export interface Params$Resource$Projects$Locations$Connections$Runtimeentityschemas$List extends StandardParameters {
/**
* Required. Filter Format: entity="{entityId\}" Only entity field is supported with literal equality operator. Accepted filter example: entity="Order" Wildcards are not supported in the filter currently.
*/
filter?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of RuntimeEntitySchema Format: projects/{project\}/locations/{location\}/connections/{connection\}
*/
parent?: string;
}
export class Resource$Projects$Locations$Endpointattachments {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new EndpointAttachment in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Endpointattachments$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Endpointattachments$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Endpointattachments$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Endpointattachments$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Endpointattachments$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a single EndpointAttachment.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Endpointattachments$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Endpointattachments$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Endpointattachments$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Endpointattachments$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Endpointattachments$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Gets details of a single EndpointAttachment.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Endpointattachments$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Endpointattachments$Get, options?: MethodOptions): GaxiosPromise<Schema$EndpointAttachment>;
get(params: Params$Resource$Projects$Locations$Endpointattachments$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Endpointattachments$Get, options: MethodOptions | BodyResponseCallback<Schema$EndpointAttachment>, callback: BodyResponseCallback<Schema$EndpointAttachment>): void;
get(params: Params$Resource$Projects$Locations$Endpointattachments$Get, callback: BodyResponseCallback<Schema$EndpointAttachment>): void;
get(callback: BodyResponseCallback<Schema$EndpointAttachment>): void;
/**
* List EndpointAttachments in a given project
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Endpointattachments$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Endpointattachments$List, options?: MethodOptions): GaxiosPromise<Schema$ListEndpointAttachmentsResponse>;
list(params: Params$Resource$Projects$Locations$Endpointattachments$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Endpointattachments$List, options: MethodOptions | BodyResponseCallback<Schema$ListEndpointAttachmentsResponse>, callback: BodyResponseCallback<Schema$ListEndpointAttachmentsResponse>): void;
list(params: Params$Resource$Projects$Locations$Endpointattachments$List, callback: BodyResponseCallback<Schema$ListEndpointAttachmentsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListEndpointAttachmentsResponse>): void;
/**
* Updates the parameters of a single EndpointAttachment.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Endpointattachments$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Endpointattachments$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Endpointattachments$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Endpointattachments$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Endpointattachments$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Endpointattachments$Create extends StandardParameters {
/**
* Required. Identifier to assign to the EndpointAttachment. Must be unique within scope of the parent resource.
*/
endpointAttachmentId?: string;
/**
* Required. Parent resource of the EndpointAttachment, of the form: `projects/x/locations/x`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EndpointAttachment;
}
export interface Params$Resource$Projects$Locations$Endpointattachments$Delete extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/endpointAttachments/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Endpointattachments$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/endpointAttachments/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Endpointattachments$List extends StandardParameters {
/**
* Filter.
*/
filter?: string;
/**
* Order by parameters.
*/
orderBy?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource od the EndpointAttachment, of the form: `projects/x/locations/x`
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Endpointattachments$Patch extends StandardParameters {
/**
* Output only. Resource name of the Endpoint Attachment. Format: projects/{project\}/locations/{location\}/endpointAttachments/{endpoint_attachment\}
*/
name?: string;
/**
* Required. The list of fields to update. Fields are specified relative to the endpointAttachment. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the endpointAttachment details: * `description` * `labels`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$EndpointAttachment;
}
export class Resource$Projects$Locations$Global {
context: APIRequestContext;
customConnectors: Resource$Projects$Locations$Global$Customconnectors;
managedZones: Resource$Projects$Locations$Global$Managedzones;
constructor(context: APIRequestContext);
/**
* GetGlobalSettings gets settings of a project. GlobalSettings is a singleton resource.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getSettings(params: Params$Resource$Projects$Locations$Global$Getsettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
getSettings(params?: Params$Resource$Projects$Locations$Global$Getsettings, options?: MethodOptions): GaxiosPromise<Schema$Settings>;
getSettings(params: Params$Resource$Projects$Locations$Global$Getsettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getSettings(params: Params$Resource$Projects$Locations$Global$Getsettings, options: MethodOptions | BodyResponseCallback<Schema$Settings>, callback: BodyResponseCallback<Schema$Settings>): void;
getSettings(params: Params$Resource$Projects$Locations$Global$Getsettings, callback: BodyResponseCallback<Schema$Settings>): void;
getSettings(callback: BodyResponseCallback<Schema$Settings>): void;
/**
* Update the global settings of a project.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
updateSettings(params: Params$Resource$Projects$Locations$Global$Updatesettings, options: StreamMethodOptions): GaxiosPromise<Readable>;
updateSettings(params?: Params$Resource$Projects$Locations$Global$Updatesettings, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
updateSettings(params: Params$Resource$Projects$Locations$Global$Updatesettings, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
updateSettings(params: Params$Resource$Projects$Locations$Global$Updatesettings, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
updateSettings(params: Params$Resource$Projects$Locations$Global$Updatesettings, callback: BodyResponseCallback<Schema$Operation>): void;
updateSettings(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Global$Getsettings extends StandardParameters {
/**
* Required. The resource name of the Settings.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Updatesettings extends StandardParameters {
/**
* Output only. Resource name of the Connection. Format: projects/{project\}/locations/global/settings\}
*/
name?: string;
/**
* Required. The list of fields to update.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Settings;
}
export class Resource$Projects$Locations$Global$Customconnectors {
context: APIRequestContext;
customConnectorVersions: Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions;
constructor(context: APIRequestContext);
/**
* Creates a new CustomConnector in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a single CustomConnector.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Gets details of a single CustomConnector.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Get, options?: MethodOptions): GaxiosPromise<Schema$CustomConnector>;
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Get, options: MethodOptions | BodyResponseCallback<Schema$CustomConnector>, callback: BodyResponseCallback<Schema$CustomConnector>): void;
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Get, callback: BodyResponseCallback<Schema$CustomConnector>): void;
get(callback: BodyResponseCallback<Schema$CustomConnector>): void;
/**
* List CustomConnectorVersions in a given project
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Global$Customconnectors$List, options?: MethodOptions): GaxiosPromise<Schema$ListCustomConnectorsResponse>;
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$List, options: MethodOptions | BodyResponseCallback<Schema$ListCustomConnectorsResponse>, callback: BodyResponseCallback<Schema$ListCustomConnectorsResponse>): void;
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$List, callback: BodyResponseCallback<Schema$ListCustomConnectorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCustomConnectorsResponse>): void;
/**
* Updates the parameters of a CustomConnector.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Create extends StandardParameters {
/**
* Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.
*/
customConnectorId?: string;
/**
* Required. Parent resource of the CreateCustomConnector, of the form: `projects/{project\}/locations/x`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomConnector;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Delete extends StandardParameters {
/**
* Optional. If set to true, any customConnectorVersion which is a child resource will also be deleted. https://aip.dev/135#cascading-delete
*/
force?: boolean;
/**
* Required. Resource name of the form: `projects/{project\}/locations/{location\}/customConnectors/{connector\}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/customConnectors/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$List extends StandardParameters {
/**
* Filter string.
*/
filter?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the custom connectors, of the form: `projects/x/locations/x` Only global location is supported for CustomConnector resource.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Patch extends StandardParameters {
/**
* Identifier. Resource name of the CustomConnector. Format: projects/{project\}/locations/{location\}/customConnectors/{connector\}
*/
name?: string;
/**
* Required. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Set the mask as "*" for full replacement, which means all fields will be overwritten.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomConnector;
}
export class Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new CustomConnectorVersion in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a single CustomConnectorVersion.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Gets details of a single CustomConnectorVersion.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get, options?: MethodOptions): GaxiosPromise<Schema$CustomConnectorVersion>;
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get, options: MethodOptions | BodyResponseCallback<Schema$CustomConnectorVersion>, callback: BodyResponseCallback<Schema$CustomConnectorVersion>): void;
get(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get, callback: BodyResponseCallback<Schema$CustomConnectorVersion>): void;
get(callback: BodyResponseCallback<Schema$CustomConnectorVersion>): void;
/**
* List CustomConnectorVersions in a given project
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$List, options?: MethodOptions): GaxiosPromise<Schema$ListCustomConnectorVersionsResponse>;
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$List, options: MethodOptions | BodyResponseCallback<Schema$ListCustomConnectorVersionsResponse>, callback: BodyResponseCallback<Schema$ListCustomConnectorVersionsResponse>): void;
list(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$List, callback: BodyResponseCallback<Schema$ListCustomConnectorVersionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCustomConnectorVersionsResponse>): void;
/**
* Updates the parameters of a CustomConnectorVersion.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Create extends StandardParameters {
/**
* Required. Identifier to assign to the CreateCustomConnectorVersion. Must be unique within scope of the parent resource.
*/
customConnectorVersionId?: string;
/**
* Required. Parent resource of the CreateCustomConnector, of the form: `projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomConnectorVersion;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Delete extends StandardParameters {
/**
* Required. Resource name of the form: `projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}/customConnectorVersions/{custom_connector_version\}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/{location\}/customConnectors/x/customConnectorVersions/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$List extends StandardParameters {
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the connectors, of the form: `projects/x/locations/{location\}/customConnectors/x/customConnectorVersions/x`
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Global$Customconnectors$Customconnectorversions$Patch extends StandardParameters {
/**
* Output only. Identifier. Resource name of the Version. Format: projects/{project\}/locations/{location\}/customConnectors/{custom_connector\}/customConnectorVersions/{custom_connector_version\}
*/
name?: string;
/**
* Required. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Set the mask as "*" for full replacement, which means all fields will be overwritten.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CustomConnectorVersion;
}
export class Resource$Projects$Locations$Global$Managedzones {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new ManagedZone in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Locations$Global$Managedzones$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Locations$Global$Managedzones$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Projects$Locations$Global$Managedzones$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Locations$Global$Managedzones$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Projects$Locations$Global$Managedzones$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Deletes a single ManagedZone.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Global$Managedzones$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Global$Managedzones$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
delete(params: Params$Resource$Projects$Locations$Global$Managedzones$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Global$Managedzones$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
delete(params: Params$Resource$Projects$Locations$Global$Managedzones$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
delete(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Gets details of a single ManagedZone.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Global$Managedzones$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Global$Managedzones$Get, options?: MethodOptions): GaxiosPromise<Schema$ManagedZone>;
get(params: Params$Resource$Projects$Locations$Global$Managedzones$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Global$Managedzones$Get, options: MethodOptions | BodyResponseCallback<Schema$ManagedZone>, callback: BodyResponseCallback<Schema$ManagedZone>): void;
get(params: Params$Resource$Projects$Locations$Global$Managedzones$Get, callback: BodyResponseCallback<Schema$ManagedZone>): void;
get(callback: BodyResponseCallback<Schema$ManagedZone>): void;
/**
* List ManagedZones in a given project
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Global$Managedzones$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Global$Managedzones$List, options?: MethodOptions): GaxiosPromise<Schema$ListManagedZonesResponse>;
list(params: Params$Resource$Projects$Locations$Global$Managedzones$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Global$Managedzones$List, options: MethodOptions | BodyResponseCallback<Schema$ListManagedZonesResponse>, callback: BodyResponseCallback<Schema$ListManagedZonesResponse>): void;
list(params: Params$Resource$Projects$Locations$Global$Managedzones$List, callback: BodyResponseCallback<Schema$ListManagedZonesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListManagedZonesResponse>): void;
/**
* Updates the parameters of a single ManagedZone.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Locations$Global$Managedzones$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Locations$Global$Managedzones$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Projects$Locations$Global$Managedzones$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Locations$Global$Managedzones$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Projects$Locations$Global$Managedzones$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Projects$Locations$Global$Managedzones$Create extends StandardParameters {
/**
* Required. Identifier to assign to the ManagedZone. Must be unique within scope of the parent resource.
*/
managedZoneId?: string;
/**
* Required. Parent resource of the ManagedZone, of the form: `projects/x/locations/global`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ManagedZone;
}
export interface Params$Resource$Projects$Locations$Global$Managedzones$Delete extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/global/managedZones/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Managedzones$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/global/managedZones/x`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Global$Managedzones$List extends StandardParameters {
/**
* Filter.
*/
filter?: string;
/**
* Order by parameters.
*/
orderBy?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the Managed Zone, of the form: `projects/x/locations/global`
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Global$Managedzones$Patch extends StandardParameters {
/**
* Output only. Resource name of the Managed Zone. Format: projects/{project\}/locations/global/managedZones/{managed_zone\}
*/
name?: string;
/**
* Required. The list of fields to update. Fields are specified relative to the managedZone. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the managedZone details: * `description` * `labels` * `target_project` * `target_network`
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ManagedZone;
}
export class Resource$Projects$Locations$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Locations$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Projects$Locations$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters {
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$CancelOperationRequest;
}
export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters {
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters {
/**
* The name of the operation resource.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters {
/**
* The standard list filter.
*/
filter?: string;
/**
* The name of the operation's parent resource.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
export class Resource$Projects$Locations$Providers {
context: APIRequestContext;
connectors: Resource$Projects$Locations$Providers$Connectors;
constructor(context: APIRequestContext);
/**
* Gets details of a provider.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Providers$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Providers$Get, options?: MethodOptions): GaxiosPromise<Schema$Provider>;
get(params: Params$Resource$Projects$Locations$Providers$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Providers$Get, options: MethodOptions | BodyResponseCallback<Schema$Provider>, callback: BodyResponseCallback<Schema$Provider>): void;
get(params: Params$Resource$Projects$Locations$Providers$Get, callback: BodyResponseCallback<Schema$Provider>): void;
get(callback: BodyResponseCallback<Schema$Provider>): void;
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getIamPolicy(params: Params$Resource$Projects$Locations$Providers$Getiampolicy, options: StreamMethodOptions): GaxiosPromise<Readable>;
getIamPolicy(params?: Params$Resource$Projects$Locations$Providers$Getiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
getIamPolicy(params: Params$Resource$Projects$Locations$Providers$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getIamPolicy(params: Params$Resource$Projects$Locations$Providers$Getiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(params: Params$Resource$Projects$Locations$Providers$Getiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* Lists Providers in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Providers$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Providers$List, options?: MethodOptions): GaxiosPromise<Schema$ListProvidersResponse>;
list(params: Params$Resource$Projects$Locations$Providers$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Providers$List, options: MethodOptions | BodyResponseCallback<Schema$ListProvidersResponse>, callback: BodyResponseCallback<Schema$ListProvidersResponse>): void;
list(params: Params$Resource$Projects$Locations$Providers$List, callback: BodyResponseCallback<Schema$ListProvidersResponse>): void;
list(callback: BodyResponseCallback<Schema$ListProvidersResponse>): void;
/**
* Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
setIamPolicy(params: Params$Resource$Projects$Locations$Providers$Setiampolicy, options: StreamMethodOptions): GaxiosPromise<Readable>;
setIamPolicy(params?: Params$Resource$Projects$Locations$Providers$Setiampolicy, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
setIamPolicy(params: Params$Resource$Projects$Locations$Providers$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
setIamPolicy(params: Params$Resource$Projects$Locations$Providers$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(params: Params$Resource$Projects$Locations$Providers$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
testIamPermissions(params: Params$Resource$Projects$Locations$Providers$Testiampermissions, options: StreamMethodOptions): GaxiosPromise<Readable>;
testIamPermissions(params?: Params$Resource$Projects$Locations$Providers$Testiampermissions, options?: MethodOptions): GaxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params: Params$Resource$Projects$Locations$Providers$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
testIamPermissions(params: Params$Resource$Projects$Locations$Providers$Testiampermissions, options: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(params: Params$Resource$Projects$Locations$Providers$Testiampermissions, callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Providers$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/providers/x` Only global location is supported for Provider resource.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Providers$Getiampolicy extends StandardParameters {
/**
* 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).
*/
'options.requestedPolicyVersion'?: number;
/**
* REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
*/
resource?: string;
}
export interface Params$Resource$Projects$Locations$Providers$List extends StandardParameters {
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the API, of the form: `projects/x/locations/x` Only global location is supported for Provider resource.
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Providers$Setiampolicy extends StandardParameters {
/**
* REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SetIamPolicyRequest;
}
export interface Params$Resource$Projects$Locations$Providers$Testiampermissions extends StandardParameters {
/**
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
export class Resource$Projects$Locations$Providers$Connectors {
context: APIRequestContext;
versions: Resource$Projects$Locations$Providers$Connectors$Versions;
constructor(context: APIRequestContext);
/**
* Gets details of a single Connector.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Providers$Connectors$Get, options?: MethodOptions): GaxiosPromise<Schema$Connector>;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Get, options: MethodOptions | BodyResponseCallback<Schema$Connector>, callback: BodyResponseCallback<Schema$Connector>): void;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Get, callback: BodyResponseCallback<Schema$Connector>): void;
get(callback: BodyResponseCallback<Schema$Connector>): void;
/**
* Lists Connectors in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Providers$Connectors$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Providers$Connectors$List, options?: MethodOptions): GaxiosPromise<Schema$ListConnectorsResponse>;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$List, options: MethodOptions | BodyResponseCallback<Schema$ListConnectorsResponse>, callback: BodyResponseCallback<Schema$ListConnectorsResponse>): void;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$List, callback: BodyResponseCallback<Schema$ListConnectorsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListConnectorsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Providers$Connectors$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/providers/x/connectors/x` Only global location is supported for Connector resource.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Providers$Connectors$List extends StandardParameters {
/**
* Filter string.
*/
filter?: string;
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the connectors, of the form: `projects/x/locations/x/providers/x` Only global location is supported for Connector resource.
*/
parent?: string;
}
export class Resource$Projects$Locations$Providers$Connectors$Versions {
context: APIRequestContext;
eventtypes: Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes;
constructor(context: APIRequestContext);
/**
* Gets details of a single connector version.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get, options?: MethodOptions): GaxiosPromise<Schema$ConnectorVersion>;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get, options: MethodOptions | BodyResponseCallback<Schema$ConnectorVersion>, callback: BodyResponseCallback<Schema$ConnectorVersion>): void;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get, callback: BodyResponseCallback<Schema$ConnectorVersion>): void;
get(callback: BodyResponseCallback<Schema$ConnectorVersion>): void;
/**
* Lists Connector Versions in a given project and location.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Providers$Connectors$Versions$List, options?: MethodOptions): GaxiosPromise<Schema$ListConnectorVersionsResponse>;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$List, options: MethodOptions | BodyResponseCallback<Schema$ListConnectorVersionsResponse>, callback: BodyResponseCallback<Schema$ListConnectorVersionsResponse>): void;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$List, callback: BodyResponseCallback<Schema$ListConnectorVersionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListConnectorVersionsResponse>): void;
}
export interface Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/providers/x/connectors/x/versions/x` Only global location is supported for ConnectorVersion resource.
*/
name?: string;
/**
* Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view.
*/
view?: string;
}
export interface Params$Resource$Projects$Locations$Providers$Connectors$Versions$List extends StandardParameters {
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the connectors, of the form: `projects/x/locations/x/providers/x/connectors/x` Only global location is supported for ConnectorVersion resource.
*/
parent?: string;
/**
* Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `BASIC` view.
*/
view?: string;
}
export class Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets details of a single event type.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$Get, options?: MethodOptions): GaxiosPromise<Schema$EventType>;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$Get, options: MethodOptions | BodyResponseCallback<Schema$EventType>, callback: BodyResponseCallback<Schema$EventType>): void;
get(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$Get, callback: BodyResponseCallback<Schema$EventType>): void;
get(callback: BodyResponseCallback<Schema$EventType>): void;
/**
* Lists Event Types in a given Connector Version.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$List, options?: MethodOptions): GaxiosPromise<Schema$ListEventTypesResponse>;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$List, options: MethodOptions | BodyResponseCallback<Schema$ListEventTypesResponse>, callback: BodyResponseCallback<Schema$ListEventTypesResponse>): void;
list(params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$List, callback: BodyResponseCallback<Schema$ListEventTypesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListEventTypesResponse>): void;
}
export interface Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$Get extends StandardParameters {
/**
* Required. Resource name of the form: `projects/x/locations/x/providers/x/connectors/x/versions/x/eventtypes/x` Only global location is supported for EventType resource.
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Providers$Connectors$Versions$Eventtypes$List extends StandardParameters {
/**
* Page size.
*/
pageSize?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource of the connectors, of the form: `projects/x/locations/x/providers/x/connectors/x/versions/x` Only global location is supported for EventType resource.
*/
parent?: string;
}
export {};
}
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists