1883 lines
121 KiB
Ruby
1883 lines
121 KiB
Ruby
# Copyright 2020 Google LLC
|
|
#
|
|
# 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 PrivatecaV1
|
|
# Certificate Authority API
|
|
#
|
|
# The Certificate Authority Service API is a highly-available, scalable service
|
|
# that enables you to simplify and automate the management of private
|
|
# certificate authorities (CAs) while staying in control of your private keys.
|
|
#
|
|
# @example
|
|
# require 'google/apis/privateca_v1'
|
|
#
|
|
# Privateca = Google::Apis::PrivatecaV1 # Alias the module
|
|
# service = Privateca::CertificateAuthorityServiceService.new
|
|
#
|
|
# @see https://cloud.google.com/
|
|
class CertificateAuthorityServiceService < Google::Apis::Core::BaseService
|
|
# @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://privateca.googleapis.com/', '',
|
|
client_name: 'google-apis-privateca_v1',
|
|
client_version: Google::Apis::PrivatecaV1::GEM_VERSION)
|
|
@batch_path = 'batch'
|
|
end
|
|
|
|
# Gets information about a location.
|
|
# @param [String] name
|
|
# Resource name for the location.
|
|
# @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::PrivatecaV1::Location] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Location]
|
|
#
|
|
# @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_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Location::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Location
|
|
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
|
|
|
|
# Lists information about the supported locations for this service.
|
|
# @param [String] name
|
|
# The resource that owns the locations collection, if applicable.
|
|
# @param [String] filter
|
|
# A filter to narrow down results to a preferred subset. The filtering language
|
|
# accepts strings like "displayName=tokyo", and is documented in more detail in [
|
|
# AIP-160](https://google.aip.dev/160).
|
|
# @param [Fixnum] page_size
|
|
# The maximum number of results to return. If not set, the service selects a
|
|
# default.
|
|
# @param [String] page_token
|
|
# A page token received from the `next_page_token` field in the response. Send
|
|
# that page token to receive the subsequent page.
|
|
# @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::PrivatecaV1::ListLocationsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListLocationsResponse]
|
|
#
|
|
# @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_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}/locations', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListLocationsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListLocationsResponse
|
|
command.params['name'] = name unless name.nil?
|
|
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?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Create a CaPool.
|
|
# @param [String] parent
|
|
# Required. The resource name of the location associated with the CaPool, in the
|
|
# format `projects/*/locations/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CaPool] ca_pool_object
|
|
# @param [String] ca_pool_id
|
|
# Required. It must be unique within a location and match the regular expression
|
|
# `[a-zA-Z0-9_-]`1,63``
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_ca_pool(parent, ca_pool_object = nil, ca_pool_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+parent}/caPools', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CaPool::Representation
|
|
command.request_object = ca_pool_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['caPoolId'] = ca_pool_id unless ca_pool_id.nil?
|
|
command.query['requestId'] = request_id unless request_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
|
|
|
|
# Delete a CaPool.
|
|
# @param [String] name
|
|
# Required. The resource name for this CaPool in the format `projects/*/
|
|
# locations/*/caPools/*`.
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_ca_pool(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_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
|
|
|
|
# FetchCaCerts returns the current trust anchor for the CaPool. This will
|
|
# include CA certificate chains for all ACTIVE CertificateAuthority resources in
|
|
# the CaPool.
|
|
# @param [String] ca_pool
|
|
# Required. The resource name for the CaPool in the format `projects/*/locations/
|
|
# */caPools/*`.
|
|
# @param [Google::Apis::PrivatecaV1::FetchCaCertsRequest] fetch_ca_certs_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::PrivatecaV1::FetchCaCertsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::FetchCaCertsResponse]
|
|
#
|
|
# @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 fetch_ca_pool_ca_certs(ca_pool, fetch_ca_certs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+caPool}:fetchCaCerts', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::FetchCaCertsRequest::Representation
|
|
command.request_object = fetch_ca_certs_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::FetchCaCertsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::FetchCaCertsResponse
|
|
command.params['caPool'] = ca_pool unless ca_pool.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Returns a CaPool.
|
|
# @param [String] name
|
|
# Required. The name of the CaPool to get.
|
|
# @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::PrivatecaV1::CaPool] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::CaPool]
|
|
#
|
|
# @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_location_ca_pool(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::CaPool::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::CaPool
|
|
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
|
|
|
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
# resource exists and does not have a policy set.
|
|
# @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 [Fixnum] options_requested_policy_version
|
|
# Optional. The maximum policy version that will be used to format the policy.
|
|
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
|
# rejected. Requests for policies with any conditional role bindings must
|
|
# specify version 3. Policies with no conditional role bindings may specify any
|
|
# valid value or leave the field unset. The policy in the response might use the
|
|
# policy version that you specified, or it might use a lower policy version. For
|
|
# example, if you specify version 3, but the policy has no conditional role
|
|
# bindings, the response uses version 1. To learn which resources support
|
|
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
|
|
# google.com/iam/help/conditions/resource-policies).
|
|
# @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::PrivatecaV1::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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 get_project_location_ca_pool_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Policy
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists CaPools.
|
|
# @param [String] parent
|
|
# Required. The resource name of the location associated with the CaPools, in
|
|
# the format `projects/*/locations/*`.
|
|
# @param [String] filter
|
|
# Optional. Only include resources that match the filter in the response.
|
|
# @param [String] order_by
|
|
# Optional. Specify how the results should be sorted.
|
|
# @param [Fixnum] page_size
|
|
# Optional. Limit on the number of CaPools to include in the response. Further
|
|
# CaPools can subsequently be obtained by including the ListCaPoolsResponse.
|
|
# next_page_token in a subsequent request. If unspecified, the server will pick
|
|
# an appropriate default.
|
|
# @param [String] page_token
|
|
# Optional. Pagination token, returned earlier via ListCaPoolsResponse.
|
|
# next_page_token.
|
|
# @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::PrivatecaV1::ListCaPoolsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListCaPoolsResponse]
|
|
#
|
|
# @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_project_location_ca_pools(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+parent}/caPools', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListCaPoolsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListCaPoolsResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Update a CaPool.
|
|
# @param [String] name
|
|
# Output only. The resource name for this CaPool in the format `projects/*/
|
|
# locations/*/caPools/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CaPool] ca_pool_object
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [String] update_mask
|
|
# Required. A list of fields to be updated in this request.
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 patch_project_location_ca_pool(name, ca_pool_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CaPool::Representation
|
|
command.request_object = ca_pool_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Sets the access control policy on the specified resource. Replaces any
|
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
# PERMISSION_DENIED` errors.
|
|
# @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::PrivatecaV1::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::PrivatecaV1::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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_ca_pool_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Policy
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Returns permissions that a caller has on the specified resource. If the
|
|
# resource does not exist, this will return an empty set of permissions, not a `
|
|
# NOT_FOUND` error. Note: This operation is designed to be used for building
|
|
# permission-aware UIs and command-line tools, not for authorization checking.
|
|
# This operation may "fail open" without warning.
|
|
# @param [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::PrivatecaV1::TestIamPermissionsRequest] test_iam_permissions_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::PrivatecaV1::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::TestIamPermissionsResponse]
|
|
#
|
|
# @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_ca_pool_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::TestIamPermissionsResponse
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and
|
|
# is of type SUBORDINATE. After the parent Certificate Authority signs a
|
|
# certificate signing request from FetchCertificateAuthorityCsr, this method can
|
|
# complete the activation process.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @param [Google::Apis::PrivatecaV1::ActivateCertificateAuthorityRequest] activate_certificate_authority_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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 activate_certificate_authority(name, activate_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+name}:activate', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::ActivateCertificateAuthorityRequest::Representation
|
|
command.request_object = activate_certificate_authority_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
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
|
|
|
|
# Create a new CertificateAuthority in a given Project and Location.
|
|
# @param [String] parent
|
|
# Required. The resource name of the CaPool associated with the
|
|
# CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CertificateAuthority] certificate_authority_object
|
|
# @param [String] certificate_authority_id
|
|
# Required. It must be unique within a location and match the regular expression
|
|
# `[a-zA-Z0-9_-]`1,63``
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_ca_pool_certificate_authority(parent, certificate_authority_object = nil, certificate_authority_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+parent}/certificateAuthorities', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CertificateAuthority::Representation
|
|
command.request_object = certificate_authority_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['certificateAuthorityId'] = certificate_authority_id unless certificate_authority_id.nil?
|
|
command.query['requestId'] = request_id unless request_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
|
|
|
|
# Delete a CertificateAuthority.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @param [Boolean] ignore_active_certificates
|
|
# Optional. This field allows the CA to be deleted even if the CA has active
|
|
# certs. Active certs include both unrevoked and unexpired certs.
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [Boolean] skip_grace_period
|
|
# Optional. If this flag is set, the Certificate Authority will be deleted as
|
|
# soon as possible without a 30-day grace period where undeletion would have
|
|
# been allowed. If you proceed, there will be no way to recover this CA.
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_ca_pool_certificate_authority(name, ignore_active_certificates: nil, request_id: nil, skip_grace_period: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['ignoreActiveCertificates'] = ignore_active_certificates unless ignore_active_certificates.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['skipGracePeriod'] = skip_grace_period unless skip_grace_period.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Disable a CertificateAuthority.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @param [Google::Apis::PrivatecaV1::DisableCertificateAuthorityRequest] disable_certificate_authority_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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 disable_certificate_authority(name, disable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+name}:disable', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::DisableCertificateAuthorityRequest::Representation
|
|
command.request_object = disable_certificate_authority_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
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
|
|
|
|
# Enable a CertificateAuthority.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @param [Google::Apis::PrivatecaV1::EnableCertificateAuthorityRequest] enable_certificate_authority_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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 enable_certificate_authority(name, enable_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+name}:enable', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::EnableCertificateAuthorityRequest::Representation
|
|
command.request_object = enable_certificate_authority_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
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
|
|
|
|
# Fetch a certificate signing request (CSR) from a CertificateAuthority that is
|
|
# in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must
|
|
# then be signed by the desired parent Certificate Authority, which could be
|
|
# another CertificateAuthority resource, or could be an on-prem certificate
|
|
# authority. See also ActivateCertificateAuthority.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @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::PrivatecaV1::FetchCertificateAuthorityCsrResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse]
|
|
#
|
|
# @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 fetch_project_location_ca_pool_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}:fetch', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::FetchCertificateAuthorityCsrResponse
|
|
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
|
|
|
|
# Returns a CertificateAuthority.
|
|
# @param [String] name
|
|
# Required. The name of the CertificateAuthority to get.
|
|
# @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::PrivatecaV1::CertificateAuthority] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::CertificateAuthority]
|
|
#
|
|
# @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_location_ca_pool_certificate_authority(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::CertificateAuthority::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::CertificateAuthority
|
|
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
|
|
|
|
# Lists CertificateAuthorities.
|
|
# @param [String] parent
|
|
# Required. The resource name of the CaPool associated with the
|
|
# CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`.
|
|
# @param [String] filter
|
|
# Optional. Only include resources that match the filter in the response.
|
|
# @param [String] order_by
|
|
# Optional. Specify how the results should be sorted.
|
|
# @param [Fixnum] page_size
|
|
# Optional. Limit on the number of CertificateAuthorities to include in the
|
|
# response. Further CertificateAuthorities can subsequently be obtained by
|
|
# including the ListCertificateAuthoritiesResponse.next_page_token in a
|
|
# subsequent request. If unspecified, the server will pick an appropriate
|
|
# default.
|
|
# @param [String] page_token
|
|
# Optional. Pagination token, returned earlier via
|
|
# ListCertificateAuthoritiesResponse.next_page_token.
|
|
# @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::PrivatecaV1::ListCertificateAuthoritiesResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse]
|
|
#
|
|
# @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_project_location_ca_pool_certificate_authorities(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+parent}/certificateAuthorities', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListCertificateAuthoritiesResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Update a CertificateAuthority.
|
|
# @param [String] name
|
|
# Output only. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CertificateAuthority] certificate_authority_object
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [String] update_mask
|
|
# Required. A list of fields to be updated in this request.
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 patch_project_location_ca_pool_certificate_authority(name, certificate_authority_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CertificateAuthority::Representation
|
|
command.request_object = certificate_authority_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Undelete a CertificateAuthority that has been deleted.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateAuthority in the format `
|
|
# projects/*/locations/*/caPools/*/certificateAuthorities/*`.
|
|
# @param [Google::Apis::PrivatecaV1::UndeleteCertificateAuthorityRequest] undelete_certificate_authority_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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_certificate_authority(name, undelete_certificate_authority_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+name}:undelete', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::UndeleteCertificateAuthorityRequest::Representation
|
|
command.request_object = undelete_certificate_authority_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
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
|
|
|
|
# Returns a CertificateRevocationList.
|
|
# @param [String] name
|
|
# Required. The name of the CertificateRevocationList to get.
|
|
# @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::PrivatecaV1::CertificateRevocationList] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::CertificateRevocationList]
|
|
#
|
|
# @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_location_ca_pool_certificate_authority_certificate_revocation_list(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::CertificateRevocationList::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::CertificateRevocationList
|
|
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
|
|
|
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
# resource exists and does not have a policy set.
|
|
# @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 [Fixnum] options_requested_policy_version
|
|
# Optional. The maximum policy version that will be used to format the policy.
|
|
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
|
# rejected. Requests for policies with any conditional role bindings must
|
|
# specify version 3. Policies with no conditional role bindings may specify any
|
|
# valid value or leave the field unset. The policy in the response might use the
|
|
# policy version that you specified, or it might use a lower policy version. For
|
|
# example, if you specify version 3, but the policy has no conditional role
|
|
# bindings, the response uses version 1. To learn which resources support
|
|
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
|
|
# google.com/iam/help/conditions/resource-policies).
|
|
# @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::PrivatecaV1::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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 get_project_location_ca_pool_certificate_authority_certificate_revocation_list_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Policy
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists CertificateRevocationLists.
|
|
# @param [String] parent
|
|
# Required. The resource name of the location associated with the
|
|
# CertificateRevocationLists, in the format `projects/*/locations/*/caPools/*/
|
|
# certificateAuthorities/*`.
|
|
# @param [String] filter
|
|
# Optional. Only include resources that match the filter in the response.
|
|
# @param [String] order_by
|
|
# Optional. Specify how the results should be sorted.
|
|
# @param [Fixnum] page_size
|
|
# Optional. Limit on the number of CertificateRevocationLists to include in the
|
|
# response. Further CertificateRevocationLists can subsequently be obtained by
|
|
# including the ListCertificateRevocationListsResponse.next_page_token in a
|
|
# subsequent request. If unspecified, the server will pick an appropriate
|
|
# default.
|
|
# @param [String] page_token
|
|
# Optional. Pagination token, returned earlier via
|
|
# ListCertificateRevocationListsResponse.next_page_token.
|
|
# @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::PrivatecaV1::ListCertificateRevocationListsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse]
|
|
#
|
|
# @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_project_location_ca_pool_certificate_authority_certificate_revocation_lists(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+parent}/certificateRevocationLists', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListCertificateRevocationListsResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Update a CertificateRevocationList.
|
|
# @param [String] name
|
|
# Output only. The resource name for this CertificateRevocationList in the
|
|
# format `projects/*/locations/*/caPools/*certificateAuthorities/*/
|
|
# certificateRevocationLists/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CertificateRevocationList] certificate_revocation_list_object
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [String] update_mask
|
|
# Required. A list of fields to be updated in this request.
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 patch_project_location_ca_pool_certificate_authority_certificate_revocation_list(name, certificate_revocation_list_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CertificateRevocationList::Representation
|
|
command.request_object = certificate_revocation_list_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Sets the access control policy on the specified resource. Replaces any
|
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
# PERMISSION_DENIED` errors.
|
|
# @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::PrivatecaV1::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::PrivatecaV1::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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_certificate_revocation_list_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Policy
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Returns permissions that a caller has on the specified resource. If the
|
|
# resource does not exist, this will return an empty set of permissions, not a `
|
|
# NOT_FOUND` error. Note: This operation is designed to be used for building
|
|
# permission-aware UIs and command-line tools, not for authorization checking.
|
|
# This operation may "fail open" without warning.
|
|
# @param [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::PrivatecaV1::TestIamPermissionsRequest] test_iam_permissions_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::PrivatecaV1::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::TestIamPermissionsResponse]
|
|
#
|
|
# @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_certificate_revocation_list_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::TestIamPermissionsResponse
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Create a new Certificate in a given Project, Location from a particular CaPool.
|
|
# @param [String] parent
|
|
# Required. The resource name of the CaPool associated with the Certificate, in
|
|
# the format `projects/*/locations/*/caPools/*`.
|
|
# @param [Google::Apis::PrivatecaV1::Certificate] certificate_object
|
|
# @param [String] certificate_id
|
|
# Optional. It must be unique within a location and match the regular expression
|
|
# `[a-zA-Z0-9_-]`1,63``. This field is required when using a
|
|
# CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is
|
|
# optional and its value is ignored otherwise.
|
|
# @param [String] issuing_certificate_authority_id
|
|
# Optional. The resource ID of the CertificateAuthority that should issue the
|
|
# certificate. This optional field will ignore the load-balancing scheme of the
|
|
# Pool and directly issue the certificate from the CA with the specified ID,
|
|
# contained in the same CaPool referenced by `parent`. Per-CA quota rules apply.
|
|
# If left empty, a CertificateAuthority will be chosen from the CaPool by the
|
|
# service. For example, to issue a Certificate from a Certificate Authority with
|
|
# resource name "projects/my-project/locations/us-central1/caPools/my-pool/
|
|
# certificateAuthorities/my-ca", you can set the parent to "projects/my-project/
|
|
# locations/us-central1/caPools/my-pool" and the
|
|
# issuing_certificate_authority_id to "my-ca".
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and the request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [Boolean] validate_only
|
|
# Optional. If this is true, no Certificate resource will be persisted
|
|
# regardless of the CaPool's tier, and the returned Certificate will not contain
|
|
# the pem_certificate field.
|
|
# @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::PrivatecaV1::Certificate] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Certificate]
|
|
#
|
|
# @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_location_ca_pool_certificate(parent, certificate_object = nil, certificate_id: nil, issuing_certificate_authority_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+parent}/certificates', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::Certificate::Representation
|
|
command.request_object = certificate_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Certificate
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['certificateId'] = certificate_id unless certificate_id.nil?
|
|
command.query['issuingCertificateAuthorityId'] = issuing_certificate_authority_id unless issuing_certificate_authority_id.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['validateOnly'] = validate_only unless validate_only.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Returns a Certificate.
|
|
# @param [String] name
|
|
# Required. The name of the Certificate to get.
|
|
# @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::PrivatecaV1::Certificate] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Certificate]
|
|
#
|
|
# @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_location_ca_pool_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Certificate
|
|
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
|
|
|
|
# Lists Certificates.
|
|
# @param [String] parent
|
|
# Required. The resource name of the location associated with the Certificates,
|
|
# in the format `projects/*/locations/*/caPools/*`.
|
|
# @param [String] filter
|
|
# Optional. Only include resources that match the filter in the response. For
|
|
# details on supported filters and syntax, see [Certificates Filtering
|
|
# documentation](https://cloud.google.com/certificate-authority-service/docs/
|
|
# sorting-filtering-certificates#filtering_support).
|
|
# @param [String] order_by
|
|
# Optional. Specify how the results should be sorted. For details on supported
|
|
# fields and syntax, see [Certificates Sorting documentation](https://cloud.
|
|
# google.com/certificate-authority-service/docs/sorting-filtering-certificates#
|
|
# sorting_support).
|
|
# @param [Fixnum] page_size
|
|
# Optional. Limit on the number of Certificates to include in the response.
|
|
# Further Certificates can subsequently be obtained by including the
|
|
# ListCertificatesResponse.next_page_token in a subsequent request. If
|
|
# unspecified, the server will pick an appropriate default.
|
|
# @param [String] page_token
|
|
# Optional. Pagination token, returned earlier via ListCertificatesResponse.
|
|
# next_page_token.
|
|
# @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::PrivatecaV1::ListCertificatesResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListCertificatesResponse]
|
|
#
|
|
# @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_project_location_ca_pool_certificates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+parent}/certificates', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListCertificatesResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListCertificatesResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Update a Certificate. Currently, the only field you can update is the labels
|
|
# field.
|
|
# @param [String] name
|
|
# Output only. The resource name for this Certificate in the format `projects/*/
|
|
# locations/*/caPools/*/certificates/*`.
|
|
# @param [Google::Apis::PrivatecaV1::Certificate] certificate_object
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [String] update_mask
|
|
# Required. A list of fields to be updated in this request.
|
|
# @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::PrivatecaV1::Certificate] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Certificate]
|
|
#
|
|
# @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 patch_project_location_ca_pool_certificate(name, certificate_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::Certificate::Representation
|
|
command.request_object = certificate_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Certificate
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Revoke a Certificate.
|
|
# @param [String] name
|
|
# Required. The resource name for this Certificate in the format `projects/*/
|
|
# locations/*/caPools/*/certificates/*`.
|
|
# @param [Google::Apis::PrivatecaV1::RevokeCertificateRequest] revoke_certificate_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::PrivatecaV1::Certificate] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Certificate]
|
|
#
|
|
# @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 revoke_certificate(name, revoke_certificate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+name}:revoke', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::RevokeCertificateRequest::Representation
|
|
command.request_object = revoke_certificate_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Certificate::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Certificate
|
|
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
|
|
|
|
# Create a new CertificateTemplate in a given Project and Location.
|
|
# @param [String] parent
|
|
# Required. The resource name of the location associated with the
|
|
# CertificateTemplate, in the format `projects/*/locations/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CertificateTemplate] certificate_template_object
|
|
# @param [String] certificate_template_id
|
|
# Required. It must be unique within a location and match the regular expression
|
|
# `[a-zA-Z0-9_-]`1,63``
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_certificate_template(parent, certificate_template_object = nil, certificate_template_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+parent}/certificateTemplates', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CertificateTemplate::Representation
|
|
command.request_object = certificate_template_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['certificateTemplateId'] = certificate_template_id unless certificate_template_id.nil?
|
|
command.query['requestId'] = request_id unless request_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
|
|
|
|
# DeleteCertificateTemplate deletes a CertificateTemplate.
|
|
# @param [String] name
|
|
# Required. The resource name for this CertificateTemplate in the format `
|
|
# projects/*/locations/*/certificateTemplates/*`.
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_certificate_template(name, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_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
|
|
|
|
# Returns a CertificateTemplate.
|
|
# @param [String] name
|
|
# Required. The name of the CertificateTemplate to get.
|
|
# @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::PrivatecaV1::CertificateTemplate] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::CertificateTemplate]
|
|
#
|
|
# @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_location_certificate_template(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::CertificateTemplate::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::CertificateTemplate
|
|
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
|
|
|
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
# resource exists and does not have a policy set.
|
|
# @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 [Fixnum] options_requested_policy_version
|
|
# Optional. The maximum policy version that will be used to format the policy.
|
|
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
|
# rejected. Requests for policies with any conditional role bindings must
|
|
# specify version 3. Policies with no conditional role bindings may specify any
|
|
# valid value or leave the field unset. The policy in the response might use the
|
|
# policy version that you specified, or it might use a lower policy version. For
|
|
# example, if you specify version 3, but the policy has no conditional role
|
|
# bindings, the response uses version 1. To learn which resources support
|
|
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
|
|
# google.com/iam/help/conditions/resource-policies).
|
|
# @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::PrivatecaV1::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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 get_project_location_certificate_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Policy
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Lists CertificateTemplates.
|
|
# @param [String] parent
|
|
# Required. The resource name of the location associated with the
|
|
# CertificateTemplates, in the format `projects/*/locations/*`.
|
|
# @param [String] filter
|
|
# Optional. Only include resources that match the filter in the response.
|
|
# @param [String] order_by
|
|
# Optional. Specify how the results should be sorted.
|
|
# @param [Fixnum] page_size
|
|
# Optional. Limit on the number of CertificateTemplates to include in the
|
|
# response. Further CertificateTemplates can subsequently be obtained by
|
|
# including the ListCertificateTemplatesResponse.next_page_token in a subsequent
|
|
# request. If unspecified, the server will pick an appropriate default.
|
|
# @param [String] page_token
|
|
# Optional. Pagination token, returned earlier via
|
|
# ListCertificateTemplatesResponse.next_page_token.
|
|
# @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::PrivatecaV1::ListCertificateTemplatesResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse]
|
|
#
|
|
# @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_project_location_certificate_templates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+parent}/certificateTemplates', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListCertificateTemplatesResponse
|
|
command.params['parent'] = parent unless parent.nil?
|
|
command.query['filter'] = filter unless filter.nil?
|
|
command.query['orderBy'] = order_by unless order_by.nil?
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Update a CertificateTemplate.
|
|
# @param [String] name
|
|
# Output only. The resource name for this CertificateTemplate in the format `
|
|
# projects/*/locations/*/certificateTemplates/*`.
|
|
# @param [Google::Apis::PrivatecaV1::CertificateTemplate] certificate_template_object
|
|
# @param [String] request_id
|
|
# Optional. An ID to identify requests. Specify a unique request ID so that if
|
|
# you must retry your request, the server will know to ignore the request if it
|
|
# has already been completed. The server will guarantee that for at least 60
|
|
# minutes since the first request. For example, consider a situation where you
|
|
# make an initial request and t he request times out. If you make the request
|
|
# again with the same request ID, the server can check if original operation
|
|
# with the same request ID was received, and if so, will ignore the second
|
|
# request. This prevents clients from accidentally creating duplicate
|
|
# commitments. The request ID must be a valid UUID with the exception that zero
|
|
# UUID is not supported (00000000-0000-0000-0000-000000000000).
|
|
# @param [String] update_mask
|
|
# Required. A list of fields to be updated in this request.
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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 patch_project_location_certificate_template(name, certificate_template_object = nil, request_id: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CertificateTemplate::Representation
|
|
command.request_object = certificate_template_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
command.params['name'] = name unless name.nil?
|
|
command.query['requestId'] = request_id unless request_id.nil?
|
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Sets the access control policy on the specified resource. Replaces any
|
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
# PERMISSION_DENIED` errors.
|
|
# @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::PrivatecaV1::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::PrivatecaV1::Policy] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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_certificate_template_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::SetIamPolicyRequest::Representation
|
|
command.request_object = set_iam_policy_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Policy::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Policy
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Returns permissions that a caller has on the specified resource. If the
|
|
# resource does not exist, this will return an empty set of permissions, not a `
|
|
# NOT_FOUND` error. Note: This operation is designed to be used for building
|
|
# permission-aware UIs and command-line tools, not for authorization checking.
|
|
# This operation may "fail open" without warning.
|
|
# @param [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::PrivatecaV1::TestIamPermissionsRequest] test_iam_permissions_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::PrivatecaV1::TestIamPermissionsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::TestIamPermissionsResponse]
|
|
#
|
|
# @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_certificate_template_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::TestIamPermissionsRequest::Representation
|
|
command.request_object = test_iam_permissions_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::TestIamPermissionsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::TestIamPermissionsResponse
|
|
command.params['resource'] = resource unless resource.nil?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
|
# corresponding to `Code.CANCELLED`.
|
|
# @param [String] name
|
|
# The name of the operation resource to be cancelled.
|
|
# @param [Google::Apis::PrivatecaV1::CancelOperationRequest] cancel_operation_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::PrivatecaV1::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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 cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
|
command.request_representation = Google::Apis::PrivatecaV1::CancelOperationRequest::Representation
|
|
command.request_object = cancel_operation_request_object
|
|
command.response_representation = Google::Apis::PrivatecaV1::Empty::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Empty
|
|
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
|
|
|
|
# Deletes a long-running operation. This method indicates that the client is no
|
|
# longer interested in the operation result. It does not cancel the operation.
|
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
|
# UNIMPLEMENTED`.
|
|
# @param [String] name
|
|
# The name of the operation resource to be deleted.
|
|
# @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::PrivatecaV1::Empty] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::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 delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Empty::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Empty
|
|
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
|
|
|
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
# to poll the operation result at intervals as recommended by the API service.
|
|
# @param [String] name
|
|
# The name of the operation resource.
|
|
# @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::PrivatecaV1::Operation] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::Operation]
|
|
#
|
|
# @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_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::Operation::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::Operation
|
|
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
|
|
|
|
# Lists operations that match the specified filter in the request. If the server
|
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
|
# binding allows API services to override the binding to use different resource
|
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
# service configuration. For backwards compatibility, the default name includes
|
|
# the operations collection id, however overriding users must ensure the name
|
|
# binding is the parent resource, without the operations collection id.
|
|
# @param [String] name
|
|
# The name of the operation's parent resource.
|
|
# @param [String] filter
|
|
# The standard list filter.
|
|
# @param [Fixnum] page_size
|
|
# The standard list page size.
|
|
# @param [String] page_token
|
|
# The standard list page token.
|
|
# @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::PrivatecaV1::ListOperationsResponse] parsed result object
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
#
|
|
# @return [Google::Apis::PrivatecaV1::ListOperationsResponse]
|
|
#
|
|
# @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_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
command = make_simple_command(:get, 'v1/{+name}/operations', options)
|
|
command.response_representation = Google::Apis::PrivatecaV1::ListOperationsResponse::Representation
|
|
command.response_class = Google::Apis::PrivatecaV1::ListOperationsResponse
|
|
command.params['name'] = name unless name.nil?
|
|
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?
|
|
command.query['fields'] = fields unless fields.nil?
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
execute_or_queue_command(command, &block)
|
|
end
|
|
|
|
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
|