@google-cloud/pubsub
Version:
Cloud Pub/Sub Client Library for Node.js
280 lines (279 loc) • 11 kB
TypeScript
/*!
* Copyright 2014 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CallOptions, IamProtos } from 'google-gax';
import { Omit, PubSub, RequestCallback, ResourceCallback } from './pubsub';
export type Policy = {
etag?: string | Buffer;
} & Omit<IamProtos.google.iam.v1.IPolicy, 'etag'>;
export type GetPolicyCallback = RequestCallback<Policy>;
export type SetPolicyCallback = RequestCallback<Policy>;
export type SetPolicyResponse = [Policy];
export type GetPolicyResponse = [Policy];
/**
* Allows us to get the most up to date full name of an object.
*
* @private
*/
export interface Nameable {
name: string;
}
/**
* Shows which IAM permissions is allowed.
* The key to this object are the IAM permissions (string) and the values are
* booleans, true if permissions are granted to the corresponding key.
*/
export interface IamPermissionsMap {
[key: string]: boolean;
}
export type TestIamPermissionsResponse = [
IamPermissionsMap,
IamProtos.google.iam.v1.ITestIamPermissionsResponse
];
export type TestIamPermissionsCallback = ResourceCallback<IamPermissionsMap, IamProtos.google.iam.v1.ITestIamPermissionsResponse>;
/**
* [IAM (Identity and Access
* Management)](https://cloud.google.com/pubsub/access_control) allows you to
* set permissions on individual resources and offers a wider range of roles:
* editor, owner, publisher, subscriber, and viewer. This gives you greater
* flexibility and allows you to set more fine-grained access control.
*
* For example:
* * Grant access on a per-topic or per-subscription basis, rather than for
* the whole Cloud project.
* * Grant access with limited capabilities, such as to only publish messages
* to a topic, or to only to consume messages from a subscription, but not
* to delete the topic or subscription.
*
*
* *The IAM access control features described in this document are Beta,
* including the API methods to get and set IAM policies, and to test IAM
* permissions. Cloud Pub/Sub's use of IAM features is not covered by any
* SLA or deprecation policy, and may be subject to backward-incompatible
* changes.*
*
* @class
* @param {PubSub} pubsub PubSub Object.
* @param {string} id The name of the topic or subscription.
*
* @see [Access Control Overview]{@link https://cloud.google.com/pubsub/access_control}
* @see [What is Cloud IAM?]{@link https://cloud.google.com/iam/}
*
* @example
* ```
* const {PubSub} = require('@google-cloud/pubsub');
* const pubsub = new PubSub();
*
* const topic = pubsub.topic('my-topic');
* // topic.iam
*
* const subscription = pubsub.subscription('my-subscription');
* // subscription.iam
* ```
*/
export declare class IAM {
pubsub: PubSub;
request: typeof PubSub.prototype.request;
private nameable_;
constructor(pubsub: PubSub, nameOrNameable: Nameable | string);
get id(): string;
/**
* @typedef {array} GetPolicyResponse
* @property {object} 0 The policy.
*/
/**
* @callback GetPolicyCallback
* @param {?Error} err Request error, if any.
* @param {object} acl The policy.
*/
/**
* Get the IAM policy
*
* @param {object} [gaxOptions] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {GetPolicyCallback} [callback] Callback function.
* @returns {Promise<GetPolicyResponse>}
*
* @see [Topics: getIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/getIamPolicy}
* @see [Subscriptions: getIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/getIamPolicy}
*
* @example
* ```
* const {PubSub} = require('@google-cloud/pubsub');
* const pubsub = new PubSub();
*
* const topic = pubsub.topic('my-topic');
* const subscription = topic.subscription('my-subscription');
*
* topic.iam.getPolicy(function(err, policy, apiResponse) {});
*
* subscription.iam.getPolicy(function(err, policy, apiResponse) {});
*
* //-
* // If the callback is omitted, we'll return a Promise.
* //-
* topic.iam.getPolicy().then(function(data) {
* const policy = data[0];
* const apiResponse = data[1];
* });
* ```
*/
getPolicy(gaxOpts?: CallOptions): Promise<GetPolicyResponse>;
getPolicy(callback: GetPolicyCallback): void;
getPolicy(gaxOpts: CallOptions, callback: GetPolicyCallback): void;
/**
* @typedef {array} SetPolicyResponse
* @property {object} 0 The policy.
*/
/**
* @callback SetPolicyCallback
* @param {?Error} err Request error, if any.
* @param {object} acl The policy.
*/
/**
* Set the IAM policy
*
* @throws {Error} If no policy is provided.
*
* @param {object} policy The [policy](https://cloud.google.com/pubsub/docs/reference/rest/v1/Policy).
* @param {array} [policy.bindings] Bindings associate members with roles.
* @param {Array<object>} [policy.rules] Rules to be applied to the policy.
* @param {string} [policy.etag] Etags are used to perform a read-modify-write.
* @param {object} [gaxOptions] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {SetPolicyCallback} callback Callback function.
* @returns {Promise<SetPolicyResponse>}
*
* @see [Topics: setIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/setIamPolicy}
* @see [Subscriptions: setIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/setIamPolicy}
* @see [Policy]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/Policy}
*
* @example
* ```
* const {PubSub} = require('@google-cloud/pubsub');
* const pubsub = new PubSub();
*
* const topic = pubsub.topic('my-topic');
* const subscription = topic.subscription('my-subscription');
*
* const myPolicy = {
* bindings: [
* {
* role: 'roles/pubsub.subscriber',
* members:
* ['serviceAccount:myotherproject@appspot.gserviceaccount.com']
* }
* ]
* };
*
* topic.iam.setPolicy(myPolicy, function(err, policy, apiResponse) {});
*
* subscription.iam.setPolicy(myPolicy, function(err, policy, apiResponse)
* {});
*
* //-
* // If the callback is omitted, we'll return a Promise.
* //-
* topic.iam.setPolicy(myPolicy).then(function(data) {
* const policy = data[0];
* const apiResponse = data[1];
* });
* ```
*/
setPolicy(policy: Policy, gaxOpts?: CallOptions): Promise<SetPolicyResponse>;
setPolicy(policy: Policy, gaxOpts: CallOptions, callback: SetPolicyCallback): void;
setPolicy(policy: Policy, callback: SetPolicyCallback): void;
/**
* @callback TestIamPermissionsCallback
* @param {?Error} err Request error, if any.
* @param {TestIamPermissionsAPIResponse} permissions A subset of permissions that the caller is allowed.
* @param {PermissionsResponse} apiResponse The full API response.
*/
/**
* @typedef {array} TestIamPermissionsResponse
* @property {object[]} 0 A subset of permissions that the caller is allowed.
* @property {PermissionsResponse} 1 The full API response.
*/
/**
* @typedef {string[]} PermissionsResponse
* A subset of TestPermissionsRequest.permissions that the caller is allowed.
* @see https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#google.iam.v1.TestIamPermissionsRequest
*/
/**
* Test a set of permissions for a resource.
*
* Permissions with wildcards such as `*` or `storage.*` are not allowed.
*
* @throws {Error} If permissions are not provided.
*
* @param {string|string[]} permissions The permission(s) to test for.
* @param {object} [gaxOptions] Request configuration options, outlined
* here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
* @param {TestIamPermissionsCallback} [callback] Callback function.
* @returns {Promise<TestIamPermissionsResponse>}
*
* @see [Topics: testIamPermissions API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/testIamPermissions}
* @see [Subscriptions: testIamPermissions API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/testIamPermissions}
* @see [Permissions Reference]{@link https://cloud.google.com/pubsub/access_control#permissions}
*
* @example
* ```
* const {PubSub} = require('@google-cloud/pubsub');
* const pubsub = new PubSub();
*
* const topic = pubsub.topic('my-topic');
* const subscription = topic.subscription('my-subscription');
*
* //-
* // Test a single permission.
* //-
* const test = 'pubsub.topics.update';
*
* topic.iam.testPermissions(test, function(err, permissions, apiResponse) {
* console.log(permissions);
* // {
* // "pubsub.topics.update": true
* // }
* });
*
* //-
* // Test several permissions at once.
* //-
* const tests = [
* 'pubsub.subscriptions.consume',
* 'pubsub.subscriptions.update'
* ];
*
* subscription.iam.testPermissions(tests, function(err, permissions) {
* console.log(permissions);
* // {
* // "pubsub.subscriptions.consume": true,
* // "pubsub.subscriptions.update": false
* // }
* });
*
* //-
* // If the callback is omitted, we'll return a Promise.
* //-
* topic.iam.testPermissions(test).then(function(data) {
* const permissions = data[0];
* const apiResponse = data[1];
* });
* ```
*/
testPermissions(permissions: string | string[], gaxOpts?: CallOptions): Promise<TestIamPermissionsResponse>;
testPermissions(permissions: string | string[], gaxOpts: CallOptions, callback: TestIamPermissionsCallback): void;
testPermissions(permissions: string | string[], callback: TestIamPermissionsCallback): void;
}