# 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 CertificatemanagerV1 # Certificate Manager API # # # # @example # require 'google/apis/certificatemanager_v1' # # Certificatemanager = Google::Apis::CertificatemanagerV1 # Alias the module # service = Certificatemanager::CertificateManagerService.new # # @see https://cloud.google.com/certificate-manager class CertificateManagerService < 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://certificatemanager.googleapis.com/', '', client_name: 'google-apis-certificatemanager_v1', client_version: Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::Location] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::Location::Representation command.response_class = Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::ListLocationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::ListLocationsResponse::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 # Creates a new CertificateMap in a given project and location. # @param [String] parent # Required. The parent resource of the certificate map. Must be in the format ` # projects/*/locations/*`. # @param [Google::Apis::CertificatemanagerV1::CertificateMap] certificate_map_object # @param [String] certificate_map_id # Required. A user-provided name of the certificate map. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_map(parent, certificate_map_object = nil, certificate_map_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/certificateMaps', options) command.request_representation = Google::Apis::CertificatemanagerV1::CertificateMap::Representation command.request_object = certificate_map_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['parent'] = parent unless parent.nil? command.query['certificateMapId'] = certificate_map_id unless certificate_map_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 # Deletes a single CertificateMap. A Certificate Map can't be deleted if it # contains Certificate Map Entries. Remove all the entries from the map before # calling this method. # @param [String] name # Required. A name of the certificate map to delete. Must be in the format ` # projects/*/locations/*/certificateMaps/*`. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_map(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 # Gets details of a single CertificateMap. # @param [String] name # Required. A name of the certificate map to describe. Must be in the format ` # projects/*/locations/*/certificateMaps/*`. # @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::CertificatemanagerV1::CertificateMap] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::CertificateMap] # # @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_map(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::CertificateMap::Representation command.response_class = Google::Apis::CertificatemanagerV1::CertificateMap 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 CertificateMaps in a given project and location. # @param [String] parent # Required. The project and location from which the certificate maps should be # listed, specified in the format `projects/*/locations/*`. # @param [String] filter # Filter expression to restrict the Certificates Maps returned. # @param [String] order_by # A list of Certificate Map field names used to specify the order of the # returned results. The default sorting order is ascending. To specify # descending order for a field, add a suffix " desc". # @param [Fixnum] page_size # Maximum number of certificate maps to return per call. # @param [String] page_token # The value returned by the last `ListCertificateMapsResponse`. Indicates that # this is a continuation of a prior `ListCertificateMaps` call, and that the # system should return the next page of data. # @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::CertificatemanagerV1::ListCertificateMapsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::ListCertificateMapsResponse] # # @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_maps(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}/certificateMaps', options) command.response_representation = Google::Apis::CertificatemanagerV1::ListCertificateMapsResponse::Representation command.response_class = Google::Apis::CertificatemanagerV1::ListCertificateMapsResponse 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 # Updates a CertificateMap. # @param [String] name # A user-defined name of the Certificate Map. Certificate Map names must be # unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. # @param [Google::Apis::CertificatemanagerV1::CertificateMap] certificate_map_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` # definition, see https://developers.google.com/protocol-buffers/docs/reference/ # google.protobuf#fieldmask. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_map(name, certificate_map_object = 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::CertificatemanagerV1::CertificateMap::Representation command.request_object = certificate_map_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['name'] = name unless name.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 # Creates a new CertificateMapEntry in a given project and location. # @param [String] parent # Required. The parent resource of the certificate map entry. Must be in the # format `projects/*/locations/*/certificateMaps/*`. # @param [Google::Apis::CertificatemanagerV1::CertificateMapEntry] certificate_map_entry_object # @param [String] certificate_map_entry_id # Required. A user-provided name of the certificate map entry. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_map_certificate_map_entry(parent, certificate_map_entry_object = nil, certificate_map_entry_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/certificateMapEntries', options) command.request_representation = Google::Apis::CertificatemanagerV1::CertificateMapEntry::Representation command.request_object = certificate_map_entry_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['parent'] = parent unless parent.nil? command.query['certificateMapEntryId'] = certificate_map_entry_id unless certificate_map_entry_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 # Deletes a single CertificateMapEntry. # @param [String] name # Required. A name of the certificate map entry to delete. Must be in the format # `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_map_certificate_map_entry(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 # Gets details of a single CertificateMapEntry. # @param [String] name # Required. A name of the certificate map entry to describe. Must be in the # format `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. # @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::CertificatemanagerV1::CertificateMapEntry] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::CertificateMapEntry] # # @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_map_certificate_map_entry(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::CertificateMapEntry::Representation command.response_class = Google::Apis::CertificatemanagerV1::CertificateMapEntry 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 CertificateMapEntries in a given project and location. # @param [String] parent # Required. The project, location and certificate map from which the certificate # map entries should be listed, specified in the format `projects/*/locations/*/ # certificateMaps/*`. # @param [String] filter # Filter expression to restrict the returned Certificate Map Entries. # @param [String] order_by # A list of Certificate Map Entry field names used to specify the order of the # returned results. The default sorting order is ascending. To specify # descending order for a field, add a suffix " desc". # @param [Fixnum] page_size # Maximum number of certificate map entries to return. The service may return # fewer than this value. If unspecified, at most 50 certificate map entries will # be returned. The maximum value is 1000; values above 1000 will be coerced to # 1000. # @param [String] page_token # The value returned by the last `ListCertificateMapEntriesResponse`. Indicates # that this is a continuation of a prior `ListCertificateMapEntries` call, and # that the system should return the next page of data. # @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::CertificatemanagerV1::ListCertificateMapEntriesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::ListCertificateMapEntriesResponse] # # @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_map_certificate_map_entries(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}/certificateMapEntries', options) command.response_representation = Google::Apis::CertificatemanagerV1::ListCertificateMapEntriesResponse::Representation command.response_class = Google::Apis::CertificatemanagerV1::ListCertificateMapEntriesResponse 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 # Updates a CertificateMapEntry. # @param [String] name # A user-defined name of the Certificate Map Entry. Certificate Map Entry names # must be unique globally and match pattern `projects/*/locations/*/ # certificateMaps/*/certificateMapEntries/*`. # @param [Google::Apis::CertificatemanagerV1::CertificateMapEntry] certificate_map_entry_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` # definition, see https://developers.google.com/protocol-buffers/docs/reference/ # google.protobuf#fieldmask. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_map_certificate_map_entry(name, certificate_map_entry_object = 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::CertificatemanagerV1::CertificateMapEntry::Representation command.request_object = certificate_map_entry_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['name'] = name unless name.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 # Creates a new Certificate in a given project and location. # @param [String] parent # Required. The parent resource of the certificate. Must be in the format ` # projects/*/locations/*`. # @param [Google::Apis::CertificatemanagerV1::Certificate] certificate_object # @param [String] certificate_id # Required. A user-provided name of the certificate. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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(parent, certificate_object = nil, certificate_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/certificates', options) command.request_representation = Google::Apis::CertificatemanagerV1::Certificate::Representation command.request_object = certificate_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['parent'] = parent unless parent.nil? command.query['certificateId'] = certificate_id unless certificate_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 # Deletes a single Certificate. # @param [String] name # Required. A name of the certificate to delete. Must be in the format `projects/ # */locations/*/certificates/*`. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 # Gets details of a single Certificate. # @param [String] name # Required. A name of the certificate to describe. Must be in the format ` # projects/*/locations/*/certificates/*`. # @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::CertificatemanagerV1::Certificate] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_certificate(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::Certificate::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 in a given project and location. # @param [String] parent # Required. The project and location from which the certificate should be listed, # specified in the format `projects/*/locations/*`. # @param [String] filter # Filter expression to restrict the Certificates returned. # @param [String] order_by # A list of Certificate field names used to specify the order of the returned # results. The default sorting order is ascending. To specify descending order # for a field, add a suffix " desc". # @param [Fixnum] page_size # Maximum number of certificates to return per call. # @param [String] page_token # The value returned by the last `ListCertificatesResponse`. Indicates that this # is a continuation of a prior `ListCertificates` call, and that the system # should return the next page of data. # @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::CertificatemanagerV1::ListCertificatesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_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::CertificatemanagerV1::ListCertificatesResponse::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 # Updates a Certificate. # @param [String] name # A user-defined name of the certificate. Certificate names must be unique # globally and match pattern `projects/*/locations/*/certificates/*`. # @param [Google::Apis::CertificatemanagerV1::Certificate] certificate_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` # definition, see https://developers.google.com/protocol-buffers/docs/reference/ # google.protobuf#fieldmask. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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(name, certificate_object = 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::CertificatemanagerV1::Certificate::Representation command.request_object = certificate_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['name'] = name unless name.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 # Creates a new DnsAuthorization in a given project and location. # @param [String] parent # Required. The parent resource of the dns authorization. Must be in the format ` # projects/*/locations/*`. # @param [Google::Apis::CertificatemanagerV1::DnsAuthorization] dns_authorization_object # @param [String] dns_authorization_id # Required. A user-provided name of the dns authorization. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_dns_authorization(parent, dns_authorization_object = nil, dns_authorization_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/dnsAuthorizations', options) command.request_representation = Google::Apis::CertificatemanagerV1::DnsAuthorization::Representation command.request_object = dns_authorization_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['parent'] = parent unless parent.nil? command.query['dnsAuthorizationId'] = dns_authorization_id unless dns_authorization_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 # Deletes a single DnsAuthorization. # @param [String] name # Required. A name of the dns authorization to delete. Must be in the format ` # projects/*/locations/*/dnsAuthorizations/*`. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_dns_authorization(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::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 # Gets details of a single DnsAuthorization. # @param [String] name # Required. A name of the dns authorization to describe. Must be in the format ` # projects/*/locations/*/dnsAuthorizations/*`. # @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::CertificatemanagerV1::DnsAuthorization] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::DnsAuthorization] # # @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_dns_authorization(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CertificatemanagerV1::DnsAuthorization::Representation command.response_class = Google::Apis::CertificatemanagerV1::DnsAuthorization 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 DnsAuthorizations in a given project and location. # @param [String] parent # Required. The project and location from which the dns authorizations should be # listed, specified in the format `projects/*/locations/*`. # @param [String] filter # Filter expression to restrict the Dns Authorizations returned. # @param [String] order_by # A list of Dns Authorization field names used to specify the order of the # returned results. The default sorting order is ascending. To specify # descending order for a field, add a suffix " desc". # @param [Fixnum] page_size # Maximum number of dns authorizations to return per call. # @param [String] page_token # The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that # this is a continuation of a prior `ListDnsAuthorizations` call, and that the # system should return the next page of data. # @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::CertificatemanagerV1::ListDnsAuthorizationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::ListDnsAuthorizationsResponse] # # @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_dns_authorizations(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}/dnsAuthorizations', options) command.response_representation = Google::Apis::CertificatemanagerV1::ListDnsAuthorizationsResponse::Representation command.response_class = Google::Apis::CertificatemanagerV1::ListDnsAuthorizationsResponse 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 # Updates a DnsAuthorization. # @param [String] name # A user-defined name of the dns authorization. DnsAuthorization names must be # unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. # @param [Google::Apis::CertificatemanagerV1::DnsAuthorization] dns_authorization_object # @param [String] update_mask # Required. The update mask applies to the resource. For the `FieldMask` # definition, see https://developers.google.com/protocol-buffers/docs/reference/ # google.protobuf#fieldmask. # @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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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_dns_authorization(name, dns_authorization_object = 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::CertificatemanagerV1::DnsAuthorization::Representation command.request_object = dns_authorization_object command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::Operation command.params['name'] = name unless name.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 # 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::CertificatemanagerV1::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::CertificatemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::CertificatemanagerV1::Empty::Representation command.response_class = Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::Empty::Representation command.response_class = Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::Operation::Representation command.response_class = Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::CertificatemanagerV1::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::CertificatemanagerV1::ListOperationsResponse::Representation command.response_class = Google::Apis::CertificatemanagerV1::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