Class: Google::Cloud::CertificateManager::V1::CertificateManager::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb

Overview

Client for the CertificateManager service.

API Overview

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

  • Certificate that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to fully match the regexp [a-z0-9-]{1,63}. In other words,

  • only lower case letters, digits, and hyphen are allowed
  • length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#ca_pool_path, #certificate_issuance_config_path, #certificate_map_entry_path, #certificate_map_path, #certificate_path, #dns_authorization_path, #location_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CertificateManager client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::CertificateManager::V1::CertificateManager::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CertificateManager client.

Yield Parameters:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 267

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/certificatemanager/v1/certificate_manager_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @certificate_manager_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::CertificateManager::V1::CertificateManager::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @certificate_manager_stub.endpoint
    config.universe_domain = @certificate_manager_stub.universe_domain
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Client) 


333
334
335
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 333

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::CertificateManager::V1::CertificateManager::Operations (readonly)

Get the associated client for long-running operations.

Returns:



326
327
328
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 326

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CertificateManager Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CertificateManager clients
::Google::Cloud::CertificateManager::V1::CertificateManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 85

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "CertificateManager", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_certificates.timeout = 60.0
    default_config.rpcs.list_certificates.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_certificate.timeout = 60.0
    default_config.rpcs.get_certificate.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_certificate.timeout = 60.0
    default_config.rpcs.create_certificate.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_certificate.timeout = 60.0
    default_config.rpcs.update_certificate.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_certificate.timeout = 60.0
    default_config.rpcs.delete_certificate.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_certificate_maps.timeout = 60.0
    default_config.rpcs.list_certificate_maps.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_certificate_map.timeout = 60.0
    default_config.rpcs.get_certificate_map.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_certificate_map.timeout = 60.0
    default_config.rpcs.create_certificate_map.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_certificate_map.timeout = 60.0
    default_config.rpcs.update_certificate_map.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_certificate_map.timeout = 60.0
    default_config.rpcs.delete_certificate_map.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_certificate_map_entries.timeout = 60.0
    default_config.rpcs.list_certificate_map_entries.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_certificate_map_entry.timeout = 60.0
    default_config.rpcs.get_certificate_map_entry.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_certificate_map_entry.timeout = 60.0
    default_config.rpcs.create_certificate_map_entry.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_certificate_map_entry.timeout = 60.0
    default_config.rpcs.update_certificate_map_entry.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_certificate_map_entry.timeout = 60.0
    default_config.rpcs.delete_certificate_map_entry.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_dns_authorizations.timeout = 60.0
    default_config.rpcs.list_dns_authorizations.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_dns_authorization.timeout = 60.0
    default_config.rpcs.get_dns_authorization.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_dns_authorization.timeout = 60.0
    default_config.rpcs.create_dns_authorization.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_dns_authorization.timeout = 60.0
    default_config.rpcs.update_dns_authorization.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_dns_authorization.timeout = 60.0
    default_config.rpcs.delete_dns_authorization.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_certificate_issuance_configs.timeout = 60.0
    default_config.rpcs.list_certificate_issuance_configs.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_certificate_issuance_config.timeout = 60.0
    default_config.rpcs.get_certificate_issuance_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_certificate_issuance_config.timeout = 60.0
    default_config.rpcs.create_certificate_issuance_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.delete_certificate_issuance_config.timeout = 60.0
    default_config.rpcs.delete_certificate_issuance_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the CertificateManager Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



237
238
239
240
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 237

def configure
  yield @config if block_given?
  @config
end

#create_certificate(request, options = nil) ⇒ ::Gapic::Operation #create_certificate(parent: nil, certificate_id: nil, certificate: nil) ⇒ ::Gapic::Operation

Creates a new Certificate in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::CreateCertificateRequest.new

# Call the create_certificate method.
result = client.create_certificate request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_certificate(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::CreateCertificateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_certificate(parent: nil, certificate_id: nil, certificate: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the certificate. Must be in the format projects/*/locations/*.

    • certificate_id (::String) (defaults to: nil) —

      Required. A user-provided name of the certificate.

    • certificate (::Google::Cloud::CertificateManager::V1::Certificate, ::Hash) (defaults to: nil) —

      Required. A definition of the certificate to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 582

def create_certificate request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::CreateCertificateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_certificate.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_certificate.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :create_certificate, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_certificate_issuance_config(request, options = nil) ⇒ ::Gapic::Operation #create_certificate_issuance_config(parent: nil, certificate_issuance_config_id: nil, certificate_issuance_config: nil) ⇒ ::Gapic::Operation

Creates a new CertificateIssuanceConfig in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::CreateCertificateIssuanceConfigRequest.new

# Call the create_certificate_issuance_config method.
result = client.create_certificate_issuance_config request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_certificate_issuance_config(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_issuance_config via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateIssuanceConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::CreateCertificateIssuanceConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_certificate_issuance_config(parent: nil, certificate_issuance_config_id: nil, certificate_issuance_config: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_issuance_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the certificate issuance config. Must be in the format projects/*/locations/*.

    • certificate_issuance_config_id (::String) (defaults to: nil) —

      Required. A user-provided name of the certificate config.

    • certificate_issuance_config (::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig, ::Hash) (defaults to: nil) —

      Required. A definition of the certificate issuance config to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2502

def create_certificate_issuance_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::CreateCertificateIssuanceConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_certificate_issuance_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_certificate_issuance_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_certificate_issuance_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :create_certificate_issuance_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_certificate_map(request, options = nil) ⇒ ::Gapic::Operation #create_certificate_map(parent: nil, certificate_map_id: nil, certificate_map: nil) ⇒ ::Gapic::Operation

Creates a new CertificateMap in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::CreateCertificateMapRequest.new

# Call the create_certificate_map method.
result = client.create_certificate_map request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_certificate_map(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_map via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateMapRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::CreateCertificateMapRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_certificate_map(parent: nil, certificate_map_id: nil, certificate_map: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_map via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the certificate map. Must be in the format projects/*/locations/*.

    • certificate_map_id (::String) (defaults to: nil) —

      Required. A user-provided name of the certificate map.

    • certificate_map (::Google::Cloud::CertificateManager::V1::CertificateMap, ::Hash) (defaults to: nil) —

      Required. A definition of the certificate map to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1060

def create_certificate_map request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::CreateCertificateMapRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_certificate_map.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_certificate_map.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :create_certificate_map, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_certificate_map_entry(request, options = nil) ⇒ ::Gapic::Operation #create_certificate_map_entry(parent: nil, certificate_map_entry_id: nil, certificate_map_entry: nil) ⇒ ::Gapic::Operation

Creates a new CertificateMapEntry in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::CreateCertificateMapEntryRequest.new

# Call the create_certificate_map_entry method.
result = client.create_certificate_map_entry request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_certificate_map_entry(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_map_entry via a request object, either of type Google::Cloud::CertificateManager::V1::CreateCertificateMapEntryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::CreateCertificateMapEntryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_certificate_map_entry(parent: nil, certificate_map_entry_id: nil, certificate_map_entry: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_map_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the certificate map entry. Must be in the format projects/*/locations/*/certificateMaps/*.

    • certificate_map_entry_id (::String) (defaults to: nil) —

      Required. A user-provided name of the certificate map entry.

    • certificate_map_entry (::Google::Cloud::CertificateManager::V1::CertificateMapEntry, ::Hash) (defaults to: nil) —

      Required. A definition of the certificate map entry to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1545

def create_certificate_map_entry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::CreateCertificateMapEntryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_certificate_map_entry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_certificate_map_entry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :create_certificate_map_entry, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_dns_authorization(request, options = nil) ⇒ ::Gapic::Operation #create_dns_authorization(parent: nil, dns_authorization_id: nil, dns_authorization: nil) ⇒ ::Gapic::Operation

Creates a new DnsAuthorization in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::CreateDnsAuthorizationRequest.new

# Call the create_dns_authorization method.
result = client.create_dns_authorization request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_dns_authorization(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_dns_authorization via a request object, either of type Google::Cloud::CertificateManager::V1::CreateDnsAuthorizationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::CreateDnsAuthorizationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_dns_authorization(parent: nil, dns_authorization_id: nil, dns_authorization: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_dns_authorization via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the dns authorization. Must be in the format projects/*/locations/*.

    • dns_authorization_id (::String) (defaults to: nil) —

      Required. A user-provided name of the dns authorization.

    • dns_authorization (::Google::Cloud::CertificateManager::V1::DnsAuthorization, ::Hash) (defaults to: nil) —

      Required. A definition of the dns authorization to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2023

def create_dns_authorization request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::CreateDnsAuthorizationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_dns_authorization.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_dns_authorization.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :create_dns_authorization, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_certificate(request, options = nil) ⇒ ::Gapic::Operation #delete_certificate(name: nil) ⇒ ::Gapic::Operation

Deletes a single Certificate.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::DeleteCertificateRequest.new

# Call the delete_certificate method.
result = client.delete_certificate request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_certificate(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate via a request object, either of type DeleteCertificateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_certificate(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate to delete. Must be in the format projects/*/locations/*/certificates/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 773

def delete_certificate request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::DeleteCertificateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_certificate.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_certificate.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :delete_certificate, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_certificate_issuance_config(request, options = nil) ⇒ ::Gapic::Operation #delete_certificate_issuance_config(name: nil) ⇒ ::Gapic::Operation

Deletes a single CertificateIssuanceConfig.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::DeleteCertificateIssuanceConfigRequest.new

# Call the delete_certificate_issuance_config method.
result = client.delete_certificate_issuance_config request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_certificate_issuance_config(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate_issuance_config via a request object, either of type DeleteCertificateIssuanceConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateIssuanceConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_certificate_issuance_config(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate_issuance_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate issuance config to delete. Must be in the format projects/*/locations/*/certificateIssuanceConfigs/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2596

def delete_certificate_issuance_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::DeleteCertificateIssuanceConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_certificate_issuance_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_certificate_issuance_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_certificate_issuance_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :delete_certificate_issuance_config, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_certificate_map(request, options = nil) ⇒ ::Gapic::Operation #delete_certificate_map(name: nil) ⇒ ::Gapic::Operation

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.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::DeleteCertificateMapRequest.new

# Call the delete_certificate_map method.
result = client.delete_certificate_map request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_certificate_map(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate_map via a request object, either of type DeleteCertificateMapRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateMapRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_certificate_map(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate_map via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate map to delete. Must be in the format projects/*/locations/*/certificateMaps/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1253

def delete_certificate_map request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::DeleteCertificateMapRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_certificate_map.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_certificate_map.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :delete_certificate_map, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_certificate_map_entry(request, options = nil) ⇒ ::Gapic::Operation #delete_certificate_map_entry(name: nil) ⇒ ::Gapic::Operation

Deletes a single CertificateMapEntry.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::DeleteCertificateMapEntryRequest.new

# Call the delete_certificate_map_entry method.
result = client.delete_certificate_map_entry request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_certificate_map_entry(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate_map_entry via a request object, either of type DeleteCertificateMapEntryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::DeleteCertificateMapEntryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_certificate_map_entry(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_certificate_map_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate map entry to delete. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1736

def delete_certificate_map_entry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::DeleteCertificateMapEntryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_certificate_map_entry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_certificate_map_entry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :delete_certificate_map_entry, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_dns_authorization(request, options = nil) ⇒ ::Gapic::Operation #delete_dns_authorization(name: nil) ⇒ ::Gapic::Operation

Deletes a single DnsAuthorization.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::DeleteDnsAuthorizationRequest.new

# Call the delete_dns_authorization method.
result = client.delete_dns_authorization request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_dns_authorization(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_dns_authorization via a request object, either of type DeleteDnsAuthorizationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::DeleteDnsAuthorizationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_dns_authorization(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_dns_authorization via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the dns authorization to delete. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2214

def delete_dns_authorization request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::DeleteDnsAuthorizationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_dns_authorization.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_dns_authorization.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :delete_dns_authorization, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_certificate(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::Certificate #get_certificate(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::Certificate

Gets details of a single Certificate.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::GetCertificateRequest.new

# Call the get_certificate method.
result = client.get_certificate request

# The returned object is of type Google::Cloud::CertificateManager::V1::Certificate.
p result

Overloads:

  • #get_certificate(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::Certificate

    Pass arguments to get_certificate via a request object, either of type GetCertificateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::GetCertificateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_certificate(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::Certificate

    Pass arguments to get_certificate via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate to describe. Must be in the format projects/*/locations/*/certificates/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 485

def get_certificate request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::GetCertificateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_certificate.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_certificate.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :get_certificate, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_certificate_issuance_config(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig #get_certificate_issuance_config(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig

Gets details of a single CertificateIssuanceConfig.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::GetCertificateIssuanceConfigRequest.new

# Call the get_certificate_issuance_config method.
result = client.get_certificate_issuance_config request

# The returned object is of type Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig.
p result

Overloads:

  • #get_certificate_issuance_config(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig

    Pass arguments to get_certificate_issuance_config via a request object, either of type GetCertificateIssuanceConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::GetCertificateIssuanceConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_certificate_issuance_config(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig

    Pass arguments to get_certificate_issuance_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate issuance config to describe. Must be in the format projects/*/locations/*/certificateIssuanceConfigs/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2405

def get_certificate_issuance_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::GetCertificateIssuanceConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_certificate_issuance_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_certificate_issuance_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_certificate_issuance_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :get_certificate_issuance_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_certificate_map(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMap #get_certificate_map(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMap

Gets details of a single CertificateMap.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::GetCertificateMapRequest.new

# Call the get_certificate_map method.
result = client.get_certificate_map request

# The returned object is of type Google::Cloud::CertificateManager::V1::CertificateMap.
p result

Overloads:

  • #get_certificate_map(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMap

    Pass arguments to get_certificate_map via a request object, either of type GetCertificateMapRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::GetCertificateMapRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_certificate_map(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMap

    Pass arguments to get_certificate_map via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate map to describe. Must be in the format projects/*/locations/*/certificateMaps/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 963

def get_certificate_map request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::GetCertificateMapRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_certificate_map.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_certificate_map.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :get_certificate_map, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_certificate_map_entry(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMapEntry #get_certificate_map_entry(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMapEntry

Gets details of a single CertificateMapEntry.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::GetCertificateMapEntryRequest.new

# Call the get_certificate_map_entry method.
result = client.get_certificate_map_entry request

# The returned object is of type Google::Cloud::CertificateManager::V1::CertificateMapEntry.
p result

Overloads:

  • #get_certificate_map_entry(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMapEntry

    Pass arguments to get_certificate_map_entry via a request object, either of type GetCertificateMapEntryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::GetCertificateMapEntryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_certificate_map_entry(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::CertificateMapEntry

    Pass arguments to get_certificate_map_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the certificate map entry to describe. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1448

def get_certificate_map_entry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::GetCertificateMapEntryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_certificate_map_entry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_certificate_map_entry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :get_certificate_map_entry, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_dns_authorization(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::DnsAuthorization #get_dns_authorization(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::DnsAuthorization

Gets details of a single DnsAuthorization.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::GetDnsAuthorizationRequest.new

# Call the get_dns_authorization method.
result = client.get_dns_authorization request

# The returned object is of type Google::Cloud::CertificateManager::V1::DnsAuthorization.
p result

Overloads:

  • #get_dns_authorization(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::DnsAuthorization

    Pass arguments to get_dns_authorization via a request object, either of type GetDnsAuthorizationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::GetDnsAuthorizationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_dns_authorization(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::DnsAuthorization

    Pass arguments to get_dns_authorization via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. A name of the dns authorization to describe. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1926

def get_dns_authorization request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::GetDnsAuthorizationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_dns_authorization.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_dns_authorization.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :get_dns_authorization, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificate_issuance_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig> #list_certificate_issuance_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig>

Lists CertificateIssuanceConfigs in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsRequest.new

# Call the list_certificate_issuance_configs method.
result = client.list_certificate_issuance_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig.
  p item
end

Overloads:

  • #list_certificate_issuance_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig>

    Pass arguments to list_certificate_issuance_configs via a request object, either of type ListCertificateIssuanceConfigsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_certificate_issuance_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateIssuanceConfig>

    Pass arguments to list_certificate_issuance_configs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location from which the certificate should be listed, specified in the format projects/*/locations/*.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of certificate configs to return per call.

    • page_token (::String) (defaults to: nil) —

      The value returned by the last ListCertificateIssuanceConfigsResponse. Indicates that this is a continuation of a prior ListCertificateIssuanceConfigs call, and that the system should return the next page of data.

    • filter (::String) (defaults to: nil) —

      Filter expression to restrict the Certificates Configs returned.

    • order_by (::String) (defaults to: nil) —

      A list of Certificate Config 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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2318

def list_certificate_issuance_configs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_certificate_issuance_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_certificate_issuance_configs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_certificate_issuance_configs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :list_certificate_issuance_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @certificate_manager_stub, :list_certificate_issuance_configs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificate_map_entries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMapEntry> #list_certificate_map_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMapEntry>

Lists CertificateMapEntries in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesRequest.new

# Call the list_certificate_map_entries method.
result = client.list_certificate_map_entries request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CertificateManager::V1::CertificateMapEntry.
  p item
end

Overloads:

  • #list_certificate_map_entries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMapEntry>

    Pass arguments to list_certificate_map_entries via a request object, either of type ListCertificateMapEntriesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_certificate_map_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMapEntry>

    Pass arguments to list_certificate_map_entries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format projects/*/locations/*/certificateMaps/*.

    • page_size (::Integer) (defaults to: nil) —

      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.

    • page_token (::String) (defaults to: nil) —

      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.

    • filter (::String) (defaults to: nil) —

      Filter expression to restrict the returned Certificate Map Entries.

    • order_by (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1361

def list_certificate_map_entries request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_certificate_map_entries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_certificate_map_entries.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_certificate_map_entries.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :list_certificate_map_entries, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @certificate_manager_stub, :list_certificate_map_entries, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificate_maps(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMap> #list_certificate_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMap>

Lists CertificateMaps in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::ListCertificateMapsRequest.new

# Call the list_certificate_maps method.
result = client.list_certificate_maps request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CertificateManager::V1::CertificateMap.
  p item
end

Overloads:

  • #list_certificate_maps(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMap>

    Pass arguments to list_certificate_maps via a request object, either of type ListCertificateMapsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::ListCertificateMapsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_certificate_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::CertificateMap>

    Pass arguments to list_certificate_maps via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location from which the certificate maps should be listed, specified in the format projects/*/locations/*.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of certificate maps to return per call.

    • page_token (::String) (defaults to: nil) —

      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.

    • filter (::String) (defaults to: nil) —

      Filter expression to restrict the Certificates Maps returned.

    • order_by (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 876

def list_certificate_maps request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::ListCertificateMapsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_certificate_maps.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_certificate_maps.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_certificate_maps.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :list_certificate_maps, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @certificate_manager_stub, :list_certificate_maps, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::Certificate> #list_certificates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::Certificate>

Lists Certificates in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::ListCertificatesRequest.new

# Call the list_certificates method.
result = client.list_certificates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CertificateManager::V1::Certificate.
  p item
end

Overloads:

  • #list_certificates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::Certificate>

    Pass arguments to list_certificates via a request object, either of type ListCertificatesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::ListCertificatesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_certificates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::Certificate>

    Pass arguments to list_certificates via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location from which the certificate should be listed, specified in the format projects/*/locations/*.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of certificates to return per call.

    • page_token (::String) (defaults to: nil) —

      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.

    • filter (::String) (defaults to: nil) —

      Filter expression to restrict the Certificates returned.

    • order_by (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 398

def list_certificates request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::ListCertificatesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_certificates.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_certificates.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_certificates.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :list_certificates, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @certificate_manager_stub, :list_certificates, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_dns_authorizations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::DnsAuthorization> #list_dns_authorizations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::DnsAuthorization>

Lists DnsAuthorizations in a given project and location.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsRequest.new

# Call the list_dns_authorizations method.
result = client.list_dns_authorizations request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::CertificateManager::V1::DnsAuthorization.
  p item
end

Overloads:

  • #list_dns_authorizations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::DnsAuthorization>

    Pass arguments to list_dns_authorizations via a request object, either of type ListDnsAuthorizationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_dns_authorizations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CertificateManager::V1::DnsAuthorization>

    Pass arguments to list_dns_authorizations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location from which the dns authorizations should be listed, specified in the format projects/*/locations/*.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of dns authorizations to return per call.

    • page_token (::String) (defaults to: nil) —

      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.

    • filter (::String) (defaults to: nil) —

      Filter expression to restrict the Dns Authorizations returned.

    • order_by (::String) (defaults to: nil) —

      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".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1839

def list_dns_authorizations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_dns_authorizations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_dns_authorizations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_dns_authorizations.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :list_dns_authorizations, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @certificate_manager_stub, :list_dns_authorizations, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


247
248
249
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 247

def universe_domain
  @certificate_manager_stub.universe_domain
end

#update_certificate(request, options = nil) ⇒ ::Gapic::Operation #update_certificate(certificate: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a Certificate.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::UpdateCertificateRequest.new

# Call the update_certificate method.
result = client.update_certificate request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_certificate(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_certificate via a request object, either of type UpdateCertificateRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::UpdateCertificateRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_certificate(certificate: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_certificate via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 679

def update_certificate request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::UpdateCertificateRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.certificate&.name
    header_params["certificate.name"] = request.certificate.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_certificate.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_certificate.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :update_certificate, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_certificate_map(request, options = nil) ⇒ ::Gapic::Operation #update_certificate_map(certificate_map: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a CertificateMap.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::UpdateCertificateMapRequest.new

# Call the update_certificate_map method.
result = client.update_certificate_map request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_certificate_map(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_certificate_map via a request object, either of type UpdateCertificateMapRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::UpdateCertificateMapRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_certificate_map(certificate_map: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_certificate_map via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1157

def update_certificate_map request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::UpdateCertificateMapRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.certificate_map&.name
    header_params["certificate_map.name"] = request.certificate_map.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_certificate_map.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_certificate_map.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :update_certificate_map, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_certificate_map_entry(request, options = nil) ⇒ ::Gapic::Operation #update_certificate_map_entry(certificate_map_entry: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a CertificateMapEntry.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::UpdateCertificateMapEntryRequest.new

# Call the update_certificate_map_entry method.
result = client.update_certificate_map_entry request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_certificate_map_entry(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_certificate_map_entry via a request object, either of type UpdateCertificateMapEntryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::UpdateCertificateMapEntryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_certificate_map_entry(certificate_map_entry: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_certificate_map_entry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 1642

def update_certificate_map_entry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::UpdateCertificateMapEntryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.certificate_map_entry&.name
    header_params["certificate_map_entry.name"] = request.certificate_map_entry.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_certificate_map_entry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_certificate_map_entry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :update_certificate_map_entry, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_dns_authorization(request, options = nil) ⇒ ::Gapic::Operation #update_dns_authorization(dns_authorization: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a DnsAuthorization.

Examples:

Basic example

require "google/cloud/certificate_manager/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::CertificateManager::V1::CertificateManager::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::CertificateManager::V1::UpdateDnsAuthorizationRequest.new

# Call the update_dns_authorization method.
result = client.update_dns_authorization request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_dns_authorization(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_dns_authorization via a request object, either of type UpdateDnsAuthorizationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::UpdateDnsAuthorizationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_dns_authorization(dns_authorization: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_dns_authorization via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/client.rb', line 2120

def update_dns_authorization request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CertificateManager::V1::UpdateDnsAuthorizationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::CertificateManager::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.dns_authorization&.name
    header_params["dns_authorization.name"] = request.dns_authorization.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_dns_authorization.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_dns_authorization.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @certificate_manager_stub.call_rpc :update_dns_authorization, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end