src/apis/bigqueryconnection/v1beta1.ts
BigQuery Connection API
Allows users to manage BigQuery connections to external data sources.
const {google} = require('googleapis');
const bigqueryconnection = google.bigqueryconnection('v1beta1');
Properties |
constructor(options: GlobalOptions, google?: GoogleConfigurable)
|
|||||||||
|
Defined in src/apis/bigqueryconnection/v1beta1.ts:116
|
|||||||||
|
Parameters :
|
| context |
Type : APIRequestContext
|
|
Defined in src/apis/bigqueryconnection/v1beta1.ts:115
|
| projects |
Type : Resource$Projects
|
|
Defined in src/apis/bigqueryconnection/v1beta1.ts:116
|
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosPromise,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace bigqueryconnection_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
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;
}
/**
* BigQuery Connection API
*
* Allows users to manage BigQuery connections to external data sources.
*
* @example
* ```js
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
* ```
*/
export class Bigqueryconnection {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.projects = new Resource$Projects(this.context);
}
}
/**
* 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;
}
/**
* Associates `members` 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 members 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 identities requesting access for a Cloud Platform 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. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
*/
members?: string[] | null;
/**
* Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* Credential info for the Cloud SQL.
*/
export interface Schema$CloudSqlCredential {
/**
* The password for the credential.
*/
password?: string | null;
/**
* The username for the credential.
*/
username?: string | null;
}
/**
* Connection properties specific to the Cloud SQL.
*/
export interface Schema$CloudSqlProperties {
/**
* Input only. Cloud SQL credential.
*/
credential?: Schema$CloudSqlCredential;
/**
* Database name.
*/
database?: string | null;
/**
* Cloud SQL instance ID in the form `project:location:instance`.
*/
instanceId?: string | null;
/**
* Type of the Cloud SQL database.
*/
type?: string | null;
}
/**
* Configuration parameters to establish connection with an external data source, except the credential attributes.
*/
export interface Schema$Connection {
/**
* Cloud SQL properties.
*/
cloudSql?: Schema$CloudSqlProperties;
/**
* Output only. The creation timestamp of the connection.
*/
creationTime?: string | null;
/**
* User provided description.
*/
description?: string | null;
/**
* User provided display name for the connection.
*/
friendlyName?: string | null;
/**
* Output only. True, if credential is configured for this connection.
*/
hasCredential?: boolean | null;
/**
* Output only. The last update timestamp of the connection.
*/
lastModifiedTime?: string | null;
/**
* The resource name of the connection in the form of: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
*/
name?: string | null;
}
/**
* Credential to use with a connection.
*/
export interface Schema$ConnectionCredential {
/**
* Credential for Cloud SQL database.
*/
cloudSql?: Schema$CloudSqlCredential;
}
/**
* 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); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {}
/**
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
*/
title?: string | null;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).
*/
requestedPolicyVersion?: number | null;
}
/**
* The response for ConnectionService.ListConnections.
*/
export interface Schema$ListConnectionsResponse {
/**
* List of connections.
*/
connections?: Schema$Connection[];
/**
* Next page token.
*/
nextPageToken?: string | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members 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` to 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 member.
*/
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;
}
/**
* 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 Cloud Platform 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;
}
/**
* 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;
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext) {
this.context = context;
this.locations = new Resource$Projects$Locations(this.context);
}
}
export class Resource$Projects$Locations {
context: APIRequestContext;
connections: Resource$Projects$Locations$Connections;
constructor(context: APIRequestContext) {
this.context = context;
this.connections = new Resource$Projects$Locations$Connections(
this.context
);
}
}
export class Resource$Projects$Locations$Connections {
context: APIRequestContext;
constructor(context: APIRequestContext) {
this.context = context;
}
/**
* Creates a new connection.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await bigqueryconnection.projects.locations.connections.create({
* // Optional. Connection id that should be assigned to the created connection.
* connectionId: 'placeholder-value',
* // Required. Parent resource name. Must be in the format `projects/{project_id\}/locations/{location_id\}`
* parent: 'projects/my-project/locations/my-location',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "cloudSql": {},
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "friendlyName": "my_friendlyName",
* // "hasCredential": false,
* // "lastModifiedTime": "my_lastModifiedTime",
* // "name": "my_name"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "cloudSql": {},
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "friendlyName": "my_friendlyName",
* // "hasCredential": false,
* // "lastModifiedTime": "my_lastModifiedTime",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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$Connection>;
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$Connection>,
callback: BodyResponseCallback<Schema$Connection>
): void;
create(
params: Params$Resource$Projects$Locations$Connections$Create,
callback: BodyResponseCallback<Schema$Connection>
): void;
create(callback: BodyResponseCallback<Schema$Connection>): void;
create(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Create
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Connection> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Connections$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+parent}/connections').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Connection>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Connection>(parameters);
}
}
/**
* Deletes connection and associated credential.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await bigqueryconnection.projects.locations.connections.delete({
* // Required. Name of the deleted connection, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
* name: 'projects/my-project/locations/my-location/connections/my-connection',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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$Empty>;
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$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(
params: Params$Resource$Projects$Locations$Connections$Delete,
callback: BodyResponseCallback<Schema$Empty>
): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
delete(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Delete
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Connections$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* Returns specified connection.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await bigqueryconnection.projects.locations.connections.get({
* // Required. Name of the requested connection, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
* name: 'projects/my-project/locations/my-location/connections/my-connection',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "cloudSql": {},
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "friendlyName": "my_friendlyName",
* // "hasCredential": false,
* // "lastModifiedTime": "my_lastModifiedTime",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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;
get(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Get
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Connection> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Connections$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'GET',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Connection>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Connection>(parameters);
}
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await bigqueryconnection.projects.locations.connections.getIamPolicy({
* // REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* resource:
* 'projects/my-project/locations/my-location/connections/my-connection',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "options": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "auditConfigs": [],
* // "bindings": [],
* // "etag": "my_etag",
* // "version": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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;
getIamPolicy(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Getiampolicy
| BodyResponseCallback<Schema$Policy>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Policy>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Policy>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Policy> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Getiampolicy;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Connections$Getiampolicy;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['resource'],
pathParams: ['resource'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Policy>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Policy>(parameters);
}
}
/**
* Returns a list of connections in the given project.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await bigqueryconnection.projects.locations.connections.list({
* // Required. Maximum number of results per page.
* maxResults: 'placeholder-value',
* // Page token.
* pageToken: 'placeholder-value',
* // Required. Parent resource name. Must be in the form: `projects/{project_id\}/locations/{location_id\}`
* parent: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "connections": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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;
list(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$List
| BodyResponseCallback<Schema$ListConnectionsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$ListConnectionsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$ListConnectionsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$ListConnectionsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Connections$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+parent}/connections').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'GET',
},
options
),
params,
requiredParams: ['parent'],
pathParams: ['parent'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$ListConnectionsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$ListConnectionsResponse>(parameters);
}
}
/**
* Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await bigqueryconnection.projects.locations.connections.patch({
* // Required. Name of the connection to update, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
* name: 'projects/my-project/locations/my-location/connections/my-connection',
* // Required. Update mask for the connection fields to be updated.
* updateMask: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "cloudSql": {},
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "friendlyName": "my_friendlyName",
* // "hasCredential": false,
* // "lastModifiedTime": "my_lastModifiedTime",
* // "name": "my_name"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "cloudSql": {},
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "friendlyName": "my_friendlyName",
* // "hasCredential": false,
* // "lastModifiedTime": "my_lastModifiedTime",
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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$Connection>;
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$Connection>,
callback: BodyResponseCallback<Schema$Connection>
): void;
patch(
params: Params$Resource$Projects$Locations$Connections$Patch,
callback: BodyResponseCallback<Schema$Connection>
): void;
patch(callback: BodyResponseCallback<Schema$Connection>): void;
patch(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Patch
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Connection>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Connection> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Patch;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Projects$Locations$Connections$Patch;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Connection>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Connection>(parameters);
}
}
/**
* Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await bigqueryconnection.projects.locations.connections.setIamPolicy({
* // REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* resource:
* 'projects/my-project/locations/my-location/connections/my-connection',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "policy": {},
* // "updateMask": "my_updateMask"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "auditConfigs": [],
* // "bindings": [],
* // "etag": "my_etag",
* // "version": 0
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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;
setIamPolicy(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Setiampolicy
| BodyResponseCallback<Schema$Policy>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Policy>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Policy>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Policy> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Setiampolicy;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Connections$Setiampolicy;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['resource'],
pathParams: ['resource'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Policy>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Policy>(parameters);
}
}
/**
* 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.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await bigqueryconnection.projects.locations.connections.testIamPermissions({
* // REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* resource:
* 'projects/my-project/locations/my-location/connections/my-connection',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "permissions": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "permissions": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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;
testIamPermissions(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Testiampermissions
| BodyResponseCallback<Schema$TestIamPermissionsResponse>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$TestIamPermissionsResponse>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$TestIamPermissionsResponse>
| BodyResponseCallback<Readable>
):
| void
| GaxiosPromise<Schema$TestIamPermissionsResponse>
| GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Testiampermissions;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Connections$Testiampermissions;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace(
/([^:]\/)\/+/g,
'$1'
),
method: 'POST',
},
options
),
params,
requiredParams: ['resource'],
pathParams: ['resource'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$TestIamPermissionsResponse>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$TestIamPermissionsResponse>(parameters);
}
}
/**
* Sets the credential for the specified connection.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/bigqueryconnection.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const bigqueryconnection = google.bigqueryconnection('v1beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/bigquery',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res =
* await bigqueryconnection.projects.locations.connections.updateCredential({
* // Required. Name of the connection, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}/credential`
* name: 'projects/my-project/locations/my-location/connections/my-connection/credential',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "cloudSql": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @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.
*/
updateCredential(
params: Params$Resource$Projects$Locations$Connections$Updatecredential,
options: StreamMethodOptions
): GaxiosPromise<Readable>;
updateCredential(
params?: Params$Resource$Projects$Locations$Connections$Updatecredential,
options?: MethodOptions
): GaxiosPromise<Schema$Empty>;
updateCredential(
params: Params$Resource$Projects$Locations$Connections$Updatecredential,
options: StreamMethodOptions | BodyResponseCallback<Readable>,
callback: BodyResponseCallback<Readable>
): void;
updateCredential(
params: Params$Resource$Projects$Locations$Connections$Updatecredential,
options: MethodOptions | BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>
): void;
updateCredential(
params: Params$Resource$Projects$Locations$Connections$Updatecredential,
callback: BodyResponseCallback<Schema$Empty>
): void;
updateCredential(callback: BodyResponseCallback<Schema$Empty>): void;
updateCredential(
paramsOrCallback?:
| Params$Resource$Projects$Locations$Connections$Updatecredential
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
optionsOrCallback?:
| MethodOptions
| StreamMethodOptions
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>,
callback?:
| BodyResponseCallback<Schema$Empty>
| BodyResponseCallback<Readable>
): void | GaxiosPromise<Schema$Empty> | GaxiosPromise<Readable> {
let params = (paramsOrCallback ||
{}) as Params$Resource$Projects$Locations$Connections$Updatecredential;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params =
{} as Params$Resource$Projects$Locations$Connections$Updatecredential;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl =
options.rootUrl || 'https://bigqueryconnection.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
method: 'PATCH',
},
options
),
params,
requiredParams: ['name'],
pathParams: ['name'],
context: this.context,
};
if (callback) {
createAPIRequest<Schema$Empty>(
parameters,
callback as BodyResponseCallback<unknown>
);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
}
export interface Params$Resource$Projects$Locations$Connections$Create
extends StandardParameters {
/**
* Optional. Connection id that should be assigned to the created connection.
*/
connectionId?: string;
/**
* Required. Parent resource name. Must be in the format `projects/{project_id\}/locations/{location_id\}`
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Connection;
}
export interface Params$Resource$Projects$Locations$Connections$Delete
extends StandardParameters {
/**
* Required. Name of the deleted connection, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Get
extends StandardParameters {
/**
* Required. Name of the requested connection, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
*/
name?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Getiampolicy
extends StandardParameters {
/**
* REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$GetIamPolicyRequest;
}
export interface Params$Resource$Projects$Locations$Connections$List
extends StandardParameters {
/**
* Required. Maximum number of results per page.
*/
maxResults?: number;
/**
* Page token.
*/
pageToken?: string;
/**
* Required. Parent resource name. Must be in the form: `projects/{project_id\}/locations/{location_id\}`
*/
parent?: string;
}
export interface Params$Resource$Projects$Locations$Connections$Patch
extends StandardParameters {
/**
* Required. Name of the connection to update, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`
*/
name?: string;
/**
* Required. Update mask for the connection fields to be updated.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Connection;
}
export interface Params$Resource$Projects$Locations$Connections$Setiampolicy
extends StandardParameters {
/**
* REQUIRED: The resource for which the policy is being specified. See the operation documentation 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 the operation documentation for the appropriate value for this field.
*/
resource?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestIamPermissionsRequest;
}
export interface Params$Resource$Projects$Locations$Connections$Updatecredential
extends StandardParameters {
/**
* Required. Name of the connection, for example: `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}/credential`
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ConnectionCredential;
}
}