googleapis
Version:
Google APIs Client Library for Node.js
1,159 lines • 75.6 kB
TypeScript
/**
* Copyright 2015 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 { AxiosPromise } from 'axios';
import { GoogleApis } from '../..';
import { BodyResponseCallback, GlobalOptions, MethodOptions } from '../../lib/api';
/**
* Cloud Resource Manager API
*
* The Google Cloud Resource Manager API provides methods for creating, reading,
* and updating project metadata.
*
* @example
* const google = require('googleapis');
* const cloudresourcemanager = google.cloudresourcemanager('v1beta1');
*
* @namespace cloudresourcemanager
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Cloudresourcemanager
*/
export declare class Cloudresourcemanager {
_options: GlobalOptions;
google: GoogleApis;
root: this;
organizations: Resource$Organizations;
projects: Resource$Projects;
constructor(options: GlobalOptions, google: GoogleApis);
getRoot(): this;
}
/**
* Identifying information for a single ancestor of a project.
*/
export interface Schema$Ancestor {
/**
* Resource id of the ancestor.
*/
resourceId: Schema$ResourceId;
}
/**
* 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:foo@gmail.com" ] }, {
* "log_type": "DATA_WRITE", }, {
* "log_type": "ADMIN_READ", } ] }, {
* "service": "fooservice.googleapis.com"
* "audit_log_configs": [ { "log_type":
* "DATA_READ", }, { "log_type":
* "DATA_WRITE", "exempted_members": [
* "user:bar@gmail.com" ] } ] } ]
* } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
* logging. It also exempts foo@gmail.com from DATA_READ logging, and
* bar@gmail.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;
}
/**
* Provides the configuration for logging a type of permissions. Example: {
* "audit_log_configs": [ { "log_type":
* "DATA_READ", "exempted_members": [
* "user:foo@gmail.com" ] }, {
* "log_type": "DATA_WRITE", } ] } This
* enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
* foo@gmail.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[];
/**
* The log type that this config enables.
*/
logType: string;
}
/**
* Associates `members` with a `role`.
*/
export interface Schema$Binding {
/**
* 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@gmail.com` or
* `joe@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`. * `domain:{domain}`: A Google Apps domain name that
* represents all the users of that domain. For example, `google.com` or
* `example.com`.
*/
members: string[];
/**
* Role that is assigned to `members`. For example, `roles/viewer`,
* `roles/editor`, or `roles/owner`. Required
*/
role: string;
}
/**
* 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 {
}
/**
* Metadata describing a long running folder operation
*/
export interface Schema$FolderOperation {
/**
* The resource name of the folder or organization we are either creating the
* folder under or moving the folder to.
*/
destinationParent: string;
/**
* The display name of the folder.
*/
displayName: string;
/**
* The type of this operation.
*/
operationType: string;
/**
* The resource name of the folder's parent. Only applicable when the
* operation_type is MOVE.
*/
sourceParent: string;
}
/**
* A classification of the Folder Operation error.
*/
export interface Schema$FolderOperationError {
/**
* The type of operation error experienced.
*/
errorMessageId: string;
}
/**
* The request sent to the GetAncestry method.
*/
export interface Schema$GetAncestryRequest {
}
/**
* Response from the GetAncestry method.
*/
export interface Schema$GetAncestryResponse {
/**
* Ancestors are ordered from bottom to top of the resource hierarchy. The
* first ancestor is the project itself, followed by the project's parent,
* etc.
*/
ancestor: Schema$Ancestor[];
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
}
/**
* The response returned from the `ListOrganizations` method.
*/
export interface Schema$ListOrganizationsResponse {
/**
* A pagination token to be used to retrieve the next page of results. If the
* result is too large to fit within the page size specified in the request,
* this field will be set with a token that can be used to fetch the next page
* of results. If this field is empty, it indicates that this response
* contains the last page of results.
*/
nextPageToken: string;
/**
* The list of Organizations that matched the list query, possibly paginated.
*/
organizations: Schema$Organization[];
}
/**
* A page of the response received from the ListProjects method. A paginated
* response where more pages are available has `next_page_token` set. This token
* can be used in a subsequent request to retrieve the next request page.
*/
export interface Schema$ListProjectsResponse {
/**
* Pagination token. If the result set is too large to fit in a single
* response, this token is returned. It encodes the position of the current
* result cursor. Feeding this value into a new list request with the
* `page_token` parameter gives the next page of the results. When
* `next_page_token` is not filled in, there is no next page and the list
* returned is the last page in the result set. Pagination tokens have a
* limited lifetime.
*/
nextPageToken: string;
/**
* The list of Projects that matched the list filter. This list can be
* paginated.
*/
projects: Schema$Project[];
}
/**
* The root node in the resource hierarchy to which a particular entity's
* (e.g., company) resources belong.
*/
export interface Schema$Organization {
/**
* Timestamp when the Organization was created. Assigned by the server.
* @OutputOnly
*/
creationTime: string;
/**
* A human-readable string that refers to the Organization in the GCP Console
* UI. This string is set by the server and cannot be changed. The string will
* be set to the primary domain (for example, "google.com") of the G
* Suite customer that owns the organization. @OutputOnly
*/
displayName: string;
/**
* The organization's current lifecycle state. Assigned by the server.
* @OutputOnly
*/
lifecycleState: string;
/**
* Output Only. The resource name of the organization. This is the
* organization's relative path in the API. Its format is
* "organizations/[organization_id]". For example,
* "organizations/1234".
*/
name: string;
/**
* An immutable id for the Organization that is assigned on creation. This
* should be omitted when creating a new Organization. This field is
* read-only.
*/
organizationId: string;
/**
* The owner of this Organization. The owner should be specified on creation.
* Once set, it cannot be changed. This field is required.
*/
owner: Schema$OrganizationOwner;
}
/**
* The entity that owns an Organization. The lifetime of the Organization and
* all of its descendants are bound to the `OrganizationOwner`. If the
* `OrganizationOwner` is deleted, the Organization and all its descendants will
* be deleted.
*/
export interface Schema$OrganizationOwner {
/**
* The G Suite customer id used in the Directory API.
*/
directoryCustomerId: string;
}
/**
* Defines an Identity and Access Management (IAM) policy. It is used to specify
* access control policies for Cloud Platform resources. A `Policy` consists
* of a list of `bindings`. A `Binding` binds a list of `members` to a `role`,
* where the members can be user accounts, Google groups, Google domains, and
* service accounts. A `role` is a named list of permissions defined by IAM.
* **Example** { "bindings": [ { "role":
* "roles/owner", "members": [
* "user:mike@example.com", "group:admins@example.com",
* "domain:google.com",
* "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, {
* "role": "roles/viewer", "members":
* ["user:sean@example.com"] } ] } For a
* description of IAM and its features, see the [IAM developer's
* guide](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`. `bindings` with no members will
* result in an error.
*/
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.
* If no `etag` is provided in the call to `setIamPolicy`, then the existing
* policy is overwritten blindly.
*/
etag: string;
/**
* Deprecated.
*/
version: number;
}
/**
* A Project is a high-level Google Cloud Platform entity. It is a container
* for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform
* resources.
*/
export interface Schema$Project {
/**
* Creation time. Read-only.
*/
createTime: string;
/**
* The labels associated with this Project. Label keys must be between 1 and
* 63 characters long and must conform to the following regular expression:
* \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63
* characters long and must conform to the regular expression
* (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be
* associated with a given resource. Clients should store labels in a
* representation such as JSON that does not depend on specific characters
* being disallowed. Example: <code>"environment" :
* "dev"</code> Read-write.
*/
labels: any;
/**
* The Project lifecycle state. Read-only.
*/
lifecycleState: string;
/**
* The user-assigned display name of the Project. It must be 4 to 30
* characters. Allowed characters are: lowercase and uppercase letters,
* numbers, hyphen, single-quote, double-quote, space, and exclamation point.
* Example: <code>My Project</code> Read-write.
*/
name: string;
/**
* An optional reference to a parent Resource. Supported parent types include
* "organization" and "folder". Once set, the parent
* cannot be cleared. The `parent` can be set on creation or using the
* `UpdateProject` method; the end user must have the
* `resourcemanager.projects.create` permission on the parent. Read-write.
*/
parent: Schema$ResourceId;
/**
* The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase
* letters, digits, or hyphens. It must start with a letter. Trailing hyphens
* are prohibited. Example: <code>tokyo-rain-123</code> Read-only
* after creation.
*/
projectId: string;
/**
* The number uniquely identifying the project. Example:
* <code>415104041262</code> Read-only.
*/
projectNumber: string;
}
/**
* A status object which is used as the `metadata` field for the Operation
* returned by CreateProject. It provides insight for when significant phases of
* Project creation have completed.
*/
export interface Schema$ProjectCreationStatus {
/**
* Creation time of the project creation workflow.
*/
createTime: string;
/**
* True if the project can be retrieved using GetProject. No other operations
* on the project are guaranteed to work until the project creation is
* complete.
*/
gettable: boolean;
/**
* True if the project creation process is complete.
*/
ready: boolean;
}
/**
* A container to reference an id for any resource type. A `resource` in Google
* Cloud Platform is a generic term for something you (a developer) may want to
* interact with through one of our API's. Some examples are an App Engine
* app, a Compute Engine instance, a Cloud SQL database, and so on.
*/
export interface Schema$ResourceId {
/**
* Required field for the type-specific id. This should correspond to the id
* used in the type-specific API's.
*/
id: string;
/**
* Required field representing the resource type this id is for. At present,
* the valid types are "project", "folder", and
* "organization".
*/
type: string;
}
/**
* 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" This
* field is only used by Cloud IAM.
*/
updateMask: string;
}
/**
* 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[];
}
/**
* Response message for `TestIamPermissions` method.
*/
export interface Schema$TestIamPermissionsResponse {
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is
* allowed.
*/
permissions: string[];
}
/**
* The request sent to the UndeleteProject method.
*/
export interface Schema$UndeleteProjectRequest {
}
export declare class Resource$Organizations {
root: Cloudresourcemanager;
constructor(root: Cloudresourcemanager);
getRoot(): Cloudresourcemanager;
/**
* cloudresourcemanager.organizations.get
* @desc Fetches an Organization resource identified by the specified resource
* name.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // The resource name of the Organization to fetch, e.g.
* "organizations/1234". name: 'organizations/my-organization', // TODO:
* Update placeholder value.
*
* auth: authClient,
* };
*
* cloudResourceManager.organizations.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.organizations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The resource name of the Organization to fetch, e.g. "organizations/1234".
* @param {string=} params.organizationId The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Organization>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Organization>, callback?: BodyResponseCallback<Schema$Organization>): void;
/**
* cloudresourcemanager.organizations.getIamPolicy
* @desc Gets the access control policy for an Organization resource. May be
* empty if no such policy or resource exists. The `resource` field should be
* the organization's resource name, e.g. "organizations/123".
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // REQUIRED: The resource for which the policy is being requested.
* // See the operation documentation for the appropriate value for this
* field. resource_: 'organizations/my-organization', // TODO: Update
* placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* cloudResourceManager.organizations.getIamPolicy(request, function(err,
* response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.organizations.getIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
* @param {().GetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getIamPolicy(params?: any, options?: MethodOptions): AxiosPromise<Schema$Policy>;
getIamPolicy(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Policy>, callback?: BodyResponseCallback<Schema$Policy>): void;
/**
* cloudresourcemanager.organizations.list
* @desc Lists Organization resources that are visible to the user and satisfy
* the specified filter. This method returns Organizations in an unspecified
* order. New Organizations do not necessarily appear at the end of the list.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var organizationsPage = response['organizations'];
* if (!organizationsPage) {
* return;
* }
* for (var i = 0; i < organizationsPage.length; i++) {
* // TODO: Change code below to process each resource in
* `organizationsPage`: console.log(JSON.stringify(organizationsPage[i], null,
* 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* cloudResourceManager.organizations.list(request, handlePage);
* }
* };
*
* cloudResourceManager.organizations.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.organizations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
* @param {integer=} params.pageSize The maximum number of Organizations to return in the response. This field is optional.
* @param {string=} params.pageToken A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: any, options?: MethodOptions): AxiosPromise<Schema$ListOrganizationsResponse>;
list(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$ListOrganizationsResponse>, callback?: BodyResponseCallback<Schema$ListOrganizationsResponse>): void;
/**
* cloudresourcemanager.organizations.setIamPolicy
* @desc Sets the access control policy on an Organization resource. Replaces
* any existing policy. The `resource` field should be the organization's
* resource name, e.g. "organizations/123".
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // REQUIRED: The resource for which the policy is being specified.
* // See the operation documentation for the appropriate value for this
* field. resource_: 'organizations/my-organization', // TODO: Update
* placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* cloudResourceManager.organizations.setIamPolicy(request, function(err,
* response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.organizations.setIamPolicy
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
* @param {().SetIamPolicyRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
setIamPolicy(params?: any, options?: MethodOptions): AxiosPromise<Schema$Policy>;
setIamPolicy(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Policy>, callback?: BodyResponseCallback<Schema$Policy>): void;
/**
* cloudresourcemanager.organizations.testIamPermissions
* @desc Returns permissions that a caller has on the specified Organization.
* The `resource` field should be the organization's resource name, e.g.
* "organizations/123".
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // REQUIRED: The resource for which the policy detail is being
* requested.
* // See the operation documentation for the appropriate value for this
* field. resource_: 'organizations/my-organization', // TODO: Update
* placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* cloudResourceManager.organizations.testIamPermissions(request,
* function(err, response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.organizations.testIamPermissions
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
* @param {().TestIamPermissionsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
testIamPermissions(params?: any, options?: MethodOptions): AxiosPromise<Schema$TestIamPermissionsResponse>;
testIamPermissions(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$TestIamPermissionsResponse>, callback?: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
/**
* cloudresourcemanager.organizations.update
* @desc Updates an Organization resource identified by the specified resource
* name.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // Output Only. The resource name of the organization. This is the
* // organization's relative path in the API. Its format is
* // "organizations/[organization_id]". For example,
* "organizations/1234". name: 'organizations/my-organization', // TODO:
* Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. All existing
* properties
* // will be replaced.
* },
*
* auth: authClient,
* };
*
* cloudResourceManager.organizations.update(request, function(err,
* response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.organizations.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".
* @param {().Organization} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: any, options?: MethodOptions): AxiosPromise<Schema$Organization>;
update(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Organization>, callback?: BodyResponseCallback<Schema$Organization>): void;
}
export declare class Resource$Projects {
root: Cloudresourcemanager;
constructor(root: Cloudresourcemanager);
getRoot(): Cloudresourcemanager;
/**
* cloudresourcemanager.projects.create
* @desc Creates a Project resource. Initially, the Project resource is owned
* by its creator exclusively. The creator can later grant permission to
* others to read or update the Project. Several APIs are activated
* automatically for the Project, including Google Cloud Storage. The parent
* is identified by a specified ResourceId, which must include both an ID and
* a type, such as project, folder, or organization.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* cloudResourceManager.projects.create(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.projects.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.useLegacyStack A safety hatch to opt out of the new reliable project creation process.
* @param {().Project} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: any, options?: MethodOptions): AxiosPromise<Schema$Project>;
create(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Project>, callback?: BodyResponseCallback<Schema$Project>): void;
/**
* cloudresourcemanager.projects.delete
* @desc Marks the Project identified by the specified `project_id` (for
* example, `my-project-123`) for deletion. This method will only affect the
* Project if it has a lifecycle state of ACTIVE. This method changes the
* Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion
* starts at an unspecified time, at which point the project is no longer
* accessible. Until the deletion completes, you can check the lifecycle
* state checked by retrieving the Project with GetProject, and the Project
* remains visible to ListProjects. However, you cannot update the project.
* After the deletion completes, the Project is not retrievable by the
* GetProject and ListProjects methods. The caller must have modify
* permissions for this Project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // The Project ID (for example, `foo-bar-123`).
* // Required.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* cloudResourceManager.projects.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.projects.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId The Project ID (for example, `foo-bar-123`). Required.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: any, options?: MethodOptions): AxiosPromise<Schema$Empty>;
delete(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Empty>, callback?: BodyResponseCallback<Schema$Empty>): void;
/**
* cloudresourcemanager.projects.get
* @desc Retrieves the Project identified by the specified `project_id` (for
* example, `my-project-123`). The caller must have read permissions for this
* Project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudResourceManager = google.cloudresourcemanager('v1beta1');
*
* authorize(function(authClient) {
* var request = {
* // The Project ID (for example, `my-project-123`).
* // Required.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* cloudResourceManager.projects.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudresourcemanager.projects.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId The Project ID (for example, `my-project-123`). Required.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: any, options?: MethodOptions): AxiosPromise<Schema$Project>;
get(params?: any, options?: MethodOptions | BodyResponseCallback<Schema$Project>, callback?: BodyResponseCallback<Schema$Project>): void;
/**
* cloudresourcemanager.projects.getAncestry
* @desc Gets a list of ancestors in the resource hierarchy for the Project
* identified by the specified `project_id` (for example, `my-project-123`).
* The caller must have read permissions for this Project.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Cloud Resource Manager API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudresourcemanager
* // 2. This sample uses Application Default Credentials for authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
*