google-api-ruby-client/generated/google/apis/cloudresourcemanager_v1beta1/service.rb

739 lines
46 KiB
Ruby
Raw Normal View History

2015-06-23 23:05:46 +00:00
# Copyright 2015 Google Inc.
#
# 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.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module CloudresourcemanagerV1beta1
# Cloud Resource Manager API
2015-06-23 23:05:46 +00:00
#
# Creates, reads, and updates metadata for Google Cloud Platform resource
# containers.
2015-06-23 23:05:46 +00:00
#
# @example
# require 'google/apis/cloudresourcemanager_v1beta1'
#
# Cloudresourcemanager = Google::Apis::CloudresourcemanagerV1beta1 # Alias the module
# service = Cloudresourcemanager::CloudResourceManagerService.new
2015-06-23 23:05:46 +00:00
#
# @see https://cloud.google.com/resource-manager
class CloudResourceManagerService < Google::Apis::Core::BaseService
2015-06-23 23:05:46 +00:00
# @return [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.
attr_accessor :key
# @return [String]
# 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.
attr_accessor :quota_user
def initialize
super('https://cloudresourcemanager.googleapis.com/', '')
2017-04-03 20:18:48 +00:00
@batch_path = 'batch'
2015-06-23 23:05:46 +00:00
end
# Fetches an Organization resource identified by the specified resource name.
# @param [String] name
# The resource name of the Organization to fetch. This is the organization's
# relative path in the API, formatted as "organizations/[organizationId]".
# For example, "organizations/1234".
# @param [String] organization_id
# The id of the Organization resource to fetch.
# This field is deprecated and will be removed in v1. Use name instead.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-02-13 23:28:52 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization(name, organization_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/{+name}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
command.params['name'] = name unless name.nil?
command.query['organizationId'] = organization_id unless organization_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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".
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
2017-07-12 20:10:42 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
2017-02-13 23:28:52 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Policy] parsed result object
2017-02-13 23:28:52 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
2017-02-13 23:28:52 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
2017-05-26 16:44:32 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-07-12 20:10:42 +00:00
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] 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|
# |------|-----------|
Autogenerated update (2019-04-25) Delete: - logging_v2beta1 Update: - adexchangebuyer2_v2beta1 - admin_reports_v1 - alertcenter_v1beta1 - androiddeviceprovisioning_v1 - androidenterprise_v1 - androidmanagement_v1 - androidpublisher_v2 - androidpublisher_v3 - appengine_v1 - appengine_v1beta - appsactivity_v1 - bigtableadmin_v1 - bigtableadmin_v2 - binaryauthorization_v1beta1 - calendar_v3 - classroom_v1 - cloudasset_v1 - cloudasset_v1beta1 - cloudbilling_v1 - cloudbuild_v1alpha1 - clouderrorreporting_v1beta1 - cloudfunctions_v1 - cloudfunctions_v1beta2 - cloudiot_v1 - cloudprivatecatalogproducer_v1beta1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - cloudsearch_v1 - cloudtasks_v2 - cloudtasks_v2beta2 - cloudtasks_v2beta3 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - containeranalysis_v1alpha1 - containeranalysis_v1beta1 - content_v2 - content_v2_1 - datastore_v1 - datastore_v1beta1 - datastore_v1beta3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - dns_v1 - dns_v1beta2 - dns_v2beta1 - docs_v1 - drive_v2 - drive_v3 - driveactivity_v2 - file_v1 - file_v1beta1 - firebasedynamiclinks_v1 - firebasehosting_v1beta1 - firebaserules_v1 - firestore_v1 - firestore_v1beta1 - firestore_v1beta2 - fitness_v1 - games_v1 - gmail_v1 - iap_v1 - iap_v1beta1 - jobs_v3 - jobs_v3p1beta1 - language_v1 - language_v1beta2 - ml_v1 - monitoring_v3 - oauth2_v1 - oauth2_v2 - people_v1 - plus_domains_v1 - plus_v1 - poly_v1 - pubsub_v1 - pubsub_v1beta2 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - run_v1alpha1 - runtimeconfig_v1beta1 - servicebroker_v1 - servicebroker_v1alpha1 - servicebroker_v1beta1 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sourcerepo_v1 - spanner_v1 - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - texttospeech_v1beta1 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vault_v1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3 - youtubereporting_v1
2019-04-25 00:37:02 +00:00
# |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 [Fixnum] page_size
# The maximum number of Organizations to return in the response.
# This field is optional.
# @param [String] page_token
# A pagination token returned from a previous call to `ListOrganizations`
# that indicates from where listing should continue.
# This field is optional.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-07-12 20:10:42 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse] parsed result object
2017-07-12 20:10:42 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse]
2017-07-12 20:10:42 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organizations(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/organizations', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-02-13 23:28:52 +00:00
execute_or_queue_command(command, &block)
end
# 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".
2017-03-27 22:14:47 +00:00
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
2017-03-27 22:14:47 +00:00
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2015-07-31 00:05:47 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Policy] parsed result object
2015-07-31 00:05:47 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
2015-07-31 00:05:47 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_organization_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
2017-03-27 22:14:47 +00:00
command.params['resource'] = resource unless resource.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2015-07-31 00:05:47 +00:00
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified Organization.
# The `resource` field should be the organization's resource name,
# e.g. "organizations/123".
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2015-07-31 00:05:47 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse] parsed result object
2015-07-31 00:05:47 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse]
2015-07-31 00:05:47 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
# Updates an Organization resource identified by the specified resource name.
# @param [String] 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 [Google::Apis::CloudresourcemanagerV1beta1::Organization] organization_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2015-12-03 01:10:07 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Organization] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Organization]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization(name, organization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/{+name}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.request_object = organization_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# This method does not associate the new project with a billing account.
# You can set or update the billing account associated with a project using
# the [`projects.updateBillingInfo`]
# (/billing/reference/rest/v1/projects/updateBillingInfo) method.
# @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object
# @param [Boolean] use_legacy_stack
# A safety hatch to opt out of the new reliable project creation process.
2017-07-12 20:10:42 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-03-31 19:53:27 +00:00
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Project] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
2017-03-31 19:53:27 +00:00
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project(project_object = nil, use_legacy_stack: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.request_object = project_object
2017-03-31 19:53:27 +00:00
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
command.query['useLegacyStack'] = use_legacy_stack unless use_legacy_stack.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
# 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
Autogenerated update (2019-04-25) Delete: - logging_v2beta1 Update: - adexchangebuyer2_v2beta1 - admin_reports_v1 - alertcenter_v1beta1 - androiddeviceprovisioning_v1 - androidenterprise_v1 - androidmanagement_v1 - androidpublisher_v2 - androidpublisher_v3 - appengine_v1 - appengine_v1beta - appsactivity_v1 - bigtableadmin_v1 - bigtableadmin_v2 - binaryauthorization_v1beta1 - calendar_v3 - classroom_v1 - cloudasset_v1 - cloudasset_v1beta1 - cloudbilling_v1 - cloudbuild_v1alpha1 - clouderrorreporting_v1beta1 - cloudfunctions_v1 - cloudfunctions_v1beta2 - cloudiot_v1 - cloudprivatecatalogproducer_v1beta1 - cloudresourcemanager_v1 - cloudresourcemanager_v1beta1 - cloudresourcemanager_v2 - cloudresourcemanager_v2beta1 - cloudsearch_v1 - cloudtasks_v2 - cloudtasks_v2beta2 - cloudtasks_v2beta3 - compute_alpha - compute_beta - compute_v1 - container_v1 - container_v1beta1 - containeranalysis_v1alpha1 - containeranalysis_v1beta1 - content_v2 - content_v2_1 - datastore_v1 - datastore_v1beta1 - datastore_v1beta3 - dialogflow_v2 - dialogflow_v2beta1 - dlp_v2 - dns_v1 - dns_v1beta2 - dns_v2beta1 - docs_v1 - drive_v2 - drive_v3 - driveactivity_v2 - file_v1 - file_v1beta1 - firebasedynamiclinks_v1 - firebasehosting_v1beta1 - firebaserules_v1 - firestore_v1 - firestore_v1beta1 - firestore_v1beta2 - fitness_v1 - games_v1 - gmail_v1 - iap_v1 - iap_v1beta1 - jobs_v3 - jobs_v3p1beta1 - language_v1 - language_v1beta2 - ml_v1 - monitoring_v3 - oauth2_v1 - oauth2_v2 - people_v1 - plus_domains_v1 - plus_v1 - poly_v1 - pubsub_v1 - pubsub_v1beta2 - remotebuildexecution_v1 - remotebuildexecution_v1alpha - remotebuildexecution_v2 - run_v1alpha1 - runtimeconfig_v1beta1 - servicebroker_v1 - servicebroker_v1alpha1 - servicebroker_v1beta1 - serviceconsumermanagement_v1 - servicemanagement_v1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - sourcerepo_v1 - spanner_v1 - sqladmin_v1beta4 - storage_v1 - storagetransfer_v1 - texttospeech_v1beta1 - toolresults_v1beta3 - tpu_v1 - tpu_v1alpha1 - vault_v1 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 - youtube_partner_v1 - youtube_v3 - youtubereporting_v1
2019-04-25 00:37:02 +00:00
# the GetProject
# and ListProjects
# methods.
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The Project ID (for example, `foo-bar-123`).
# Required.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2015-12-03 01:10:07 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Empty] parsed result object
2015-12-03 01:10:07 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Empty]
2015-12-03 01:10:07 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1beta1/projects/{projectId}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty
command.params['projectId'] = project_id unless project_id.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-02-13 23:28:52 +00:00
execute_or_queue_command(command, &block)
end
# Retrieves the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have read permissions for this Project.
# @param [String] project_id
# The Project ID (for example, `my-project-123`).
# Required.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-02-13 23:28:52 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Project] parsed result object
2017-02-13 23:28:52 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
2017-02-13 23:28:52 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1beta1/projects/{projectId}', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-07-12 20:10:42 +00:00
execute_or_queue_command(command, &block)
end
# 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.
# @param [String] project_id
# The Project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest] get_ancestry_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-07-12 20:10:42 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse] parsed result object
2017-07-12 20:10:42 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse]
2017-07-12 20:10:42 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{projectId}:getAncestry', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest::Representation
command.request_object = get_ancestry_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse
command.params['projectId'] = project_id unless project_id.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns the IAM access control policy for the specified Project.
# Permission is denied if the policy or the resource does not exist.
# For additional information about resource structure and identification,
# see [Resource Names](/apis/design/resource_names).
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-07-12 20:10:42 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Policy] parsed result object
2017-07-12 20:10:42 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
2017-07-12 20:10:42 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{resource}:getIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-07-12 20:10:42 +00:00
execute_or_queue_command(command, &block)
end
# Lists Projects that the caller has the `resourcemanager.projects.get`
# permission on and satisfy the specified filter.
# This method returns Projects in an unspecified order.
# This method is eventually consistent with project mutations; this means
# that a newly created project may not appear in the results or recent
# updates to an existing project may not be reflected in the results. To
# retrieve the latest state of a project, use the
# GetProject method.
# NOTE: If the request filter contains a `parent.type` and `parent.id` and
# the caller has the `resourcemanager.projects.list` permission on the
# parent, the results will be drawn from an alternate index which provides
# more consistent results. In future versions of this API, this List method
# will be split into List and Search to properly capture the behavorial
# difference.
2017-07-12 20:10:42 +00:00
# @param [String] filter
# An expression for filtering the results of the request. Filter rules are
# case insensitive. The fields eligible for filtering are:
# + `name`
# + `id`
# + `labels.<key>` (where *key* is the name of a label)
# + `parent.type`
# + `parent.id`
2017-07-12 20:10:42 +00:00
# Some examples of using labels as filters:
# | Filter | Description |
# |------------------|-----------------------------------------------------|
# | name:how* | The project's name starts with "how". |
# | name:Howl | The project's name is `Howl` or `howl`. |
# | name:HOWL | Equivalent to above. |
# | NAME:howl | Equivalent to above. |
# | labels.color:* | The project has the label `color`. |
# | labels.color:red | The project's label `color` has the value `red`. |
# | labels.color:red&nbsp;labels.size:big |The project's label `color` has
# the value `red` and its label `size` has the value `big`. |
# If no filter is specified, the call will return projects for which the user
# has the `resourcemanager.projects.get` permission.
# NOTE: To perform a by-parent query (eg., what projects are directly in a
# Folder), the caller must have the `resourcemanager.projects.list`
# permission on the parent and the filter must contain both a `parent.type`
# and a `parent.id` restriction
# (example: "parent.type:folder parent.id:123"). In this case an alternate
# search index is used which provides more consistent results.
2017-07-12 20:10:42 +00:00
# Optional.
# @param [Fixnum] page_size
2017-07-12 20:10:42 +00:00
# The maximum number of Projects to return in the response.
# The server can return fewer Projects than requested.
# If unspecified, server picks an appropriate default.
# Optional.
# @param [String] page_token
# A pagination token returned from a previous call to ListProjects
# that indicates from where listing should continue.
# Optional.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-07-12 20:10:42 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_projects(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2017-07-12 20:10:42 +00:00
command = make_simple_command(:get, 'v1beta1/projects', options)
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
# Sets the IAM access control policy for the specified Project. Overwrites
# any existing policy.
# The following constraints apply when using `setIamPolicy()`:
# + Project does not support `allUsers` and `allAuthenticatedUsers` as
# `members` in a `Binding` of a `Policy`.
# + The owner role can be granted only to `user` and `serviceAccount`.
# + Service accounts can be made owners of a project directly
# without any restrictions. However, to be added as an owner, a user must be
# invited via Cloud Platform console and must accept the invitation.
# + A user cannot be granted the owner role using `setIamPolicy()`. The user
# must be granted the owner role using the Cloud Platform Console and must
# explicitly accept the invitation.
# + Invitations to grant the owner role cannot be sent using
# `setIamPolicy()`; they must be sent only using the Cloud Platform Console.
# + Membership changes that leave the project without any owners that have
# accepted the Terms of Service (ToS) will be rejected.
# + If the project is not part of an organization, there must be at least
# one owner who has accepted the Terms of Service (ToS) agreement in the
# policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner
# from the policy will fail. This restriction also applies to legacy
# projects that no longer have owners who have accepted the ToS. Edits to
# IAM policies will be rejected until the lack of a ToS-accepting owner is
# rectified.
# + This method will replace the existing policy, and cannot be used to
# append additional IAM settings.
# Note: Removing service accounts from policies or changing their roles
# can render services completely inoperable. It is important to understand
# how the service account is being used before removing or updating its
# roles.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Policy]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def set_project_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{resource}:setIamPolicy', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
command.params['resource'] = resource unless resource.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified Project.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-03-27 22:14:47 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse] parsed result object
2017-03-27 22:14:47 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse]
2017-03-27 22:14:47 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{resource}:testIamPermissions', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
2017-03-27 22:14:47 +00:00
execute_or_queue_command(command, &block)
end
# Restores the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# You can only use this method for a Project that has a lifecycle state of
# DELETE_REQUESTED.
# After deletion starts, the Project cannot be restored.
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The project ID (for example, `foo-bar-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest] undelete_project_request_object
2017-07-12 20:10:42 +00:00
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def undelete_project(project_id, undelete_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1beta1/projects/{projectId}:undelete', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest::Representation
command.request_object = undelete_project_request_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty
command.params['projectId'] = project_id unless project_id.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the attributes of the Project identified by the specified
# `project_id` (for example, `my-project-123`).
# The caller must have modify permissions for this Project.
# @param [String] project_id
# The project ID (for example, `my-project-123`).
# Required.
# @param [Google::Apis::CloudresourcemanagerV1beta1::Project] project_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
2017-03-30 22:30:51 +00:00
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::CloudresourcemanagerV1beta1::Project] parsed result object
2017-03-30 22:30:51 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::CloudresourcemanagerV1beta1::Project]
2017-03-30 22:30:51 +00:00
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1beta1/projects/{projectId}', options)
command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.request_object = project_object
command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
command.params['projectId'] = project_id unless project_id.nil?
2017-07-12 20:10:42 +00:00
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
2015-06-23 23:05:46 +00:00
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end