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

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

Overview

REST 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, #trust_config_path

Constructor Details

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

Create a new CertificateManager REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the CertificateManager client.

Yield Parameters:



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
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 269

def initialize
  # 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 = ::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::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 = ::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @location_client = Google::Cloud::Location::Locations::Rest::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
    config.bindings_override = @config.bindings_override
  end
end

Instance Attribute Details

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

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

Returns:

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


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

def location_client
  @location_client
end

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

Get the associated client for long-running operations.

Returns:



320
321
322
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 320

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::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
221
222
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 87

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:



239
240
241
242
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 239

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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 560

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
  call_metadata = @config.rpcs.create_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_certificate.timeout,
                         metadata:     call_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.create_certificate request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2336

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
  call_metadata = @config.rpcs.create_certificate_issuance_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_certificate_issuance_config.timeout,
                         metadata:     call_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.create_certificate_issuance_config request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1002

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
  call_metadata = @config.rpcs.create_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_certificate_map.timeout,
                         metadata:     call_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.create_certificate_map request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1451

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
  call_metadata = @config.rpcs.create_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_certificate_map_entry.timeout,
                         metadata:     call_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.create_certificate_map_entry request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1893

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
  call_metadata = @config.rpcs.create_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_dns_authorization.timeout,
                         metadata:     call_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.create_dns_authorization request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_trust_config(request, options = nil) ⇒ ::Gapic::Operation #create_trust_config(parent: nil, trust_config_id: nil, trust_config: nil) ⇒ ::Gapic::Operation

Creates a new TrustConfig 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::Rest::Client.new

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

# Call the create_trust_config method.
result = client.create_trust_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_trust_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::CreateTrustConfigRequest, ::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_trust_config(parent: nil, trust_config_id: nil, trust_config: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_trust_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 TrustConfig. Must be in the format projects/*/locations/*.

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

      Required. A user-provided name of the TrustConfig. Must match the regexp [a-z0-9-]{1,63}.

    • trust_config (::Google::Cloud::CertificateManager::V1::TrustConfig, ::Hash) (defaults to: nil) —

      Required. A definition of the TrustConfig to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2689

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

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

  # 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
  call_metadata = @config.rpcs.create_trust_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_trust_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_trust_config.retry_policy

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

  @certificate_manager_stub.create_trust_config request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 737

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
  call_metadata = @config.rpcs.delete_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_certificate.timeout,
                         metadata:     call_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.delete_certificate request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2423

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
  call_metadata = @config.rpcs.delete_certificate_issuance_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_certificate_issuance_config.timeout,
                         metadata:     call_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.delete_certificate_issuance_config request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1181

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
  call_metadata = @config.rpcs.delete_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_certificate_map.timeout,
                         metadata:     call_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.delete_certificate_map request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1628

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
  call_metadata = @config.rpcs.delete_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_certificate_map_entry.timeout,
                         metadata:     call_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.delete_certificate_map_entry request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2070

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
  call_metadata = @config.rpcs.delete_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_dns_authorization.timeout,
                         metadata:     call_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.delete_dns_authorization request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a single TrustConfig.

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::Rest::Client.new

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

# Call the delete_trust_config method.
result = client.delete_trust_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_trust_config(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::DeleteTrustConfigRequest, ::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_trust_config(name: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_trust_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 TrustConfig to delete. Must be in the format projects/*/locations/*/trustConfigs/*.

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

      The current etag of the TrustConfig. If an etag is provided and does not match the current etag of the resource, deletion will be blocked and an ABORTED error will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2870

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

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

  # 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
  call_metadata = @config.rpcs.delete_trust_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_trust_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_trust_config.retry_policy

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

  @certificate_manager_stub.delete_trust_config request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 470

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
  call_metadata = @config.rpcs.get_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_certificate.timeout,
                         metadata:     call_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.get_certificate request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2246

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
  call_metadata = @config.rpcs.get_certificate_issuance_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_certificate_issuance_config.timeout,
                         metadata:     call_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.get_certificate_issuance_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 912

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
  call_metadata = @config.rpcs.get_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_certificate_map.timeout,
                         metadata:     call_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.get_certificate_map request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call 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
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1361

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
  call_metadata = @config.rpcs.get_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_certificate_map_entry.timeout,
                         metadata:     call_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.get_certificate_map_entry request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1803

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
  call_metadata = @config.rpcs.get_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_dns_authorization.timeout,
                         metadata:     call_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.get_dns_authorization request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_trust_config(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::TrustConfig #get_trust_config(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::TrustConfig

Gets details of a single TrustConfig.

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::Rest::Client.new

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

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

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

Overloads:

  • #get_trust_config(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::TrustConfig

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

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::GetTrustConfigRequest, ::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_trust_config(name: nil) ⇒ ::Google::Cloud::CertificateManager::V1::TrustConfig

    Pass arguments to get_trust_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 TrustConfig to describe. Must be in the format projects/*/locations/*/trustConfigs/*.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2598

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

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

  # 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
  call_metadata = @config.rpcs.get_trust_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_trust_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_trust_config.retry_policy

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

  @certificate_manager_stub.get_trust_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificate_issuance_configs(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse #list_certificate_issuance_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse

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::Rest::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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse

    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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateIssuanceConfigsResponse

    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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2167

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
  call_metadata = @config.rpcs.list_certificate_issuance_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_certificate_issuance_configs.timeout,
                         metadata:     call_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.list_certificate_issuance_configs request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificate_map_entries(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse #list_certificate_map_entries(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse

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::Rest::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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse

    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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapEntriesResponse

    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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1282

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
  call_metadata = @config.rpcs.list_certificate_map_entries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_certificate_map_entries.timeout,
                         metadata:     call_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.list_certificate_map_entries request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificate_maps(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse #list_certificate_maps(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse

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::Rest::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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse

    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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificateMapsResponse

    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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 833

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
  call_metadata = @config.rpcs.list_certificate_maps.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_certificate_maps.timeout,
                         metadata:     call_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.list_certificate_maps request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_certificates(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificatesResponse #list_certificates(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificatesResponse

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::Rest::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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificatesResponse

    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) ⇒ ::Google::Cloud::CertificateManager::V1::ListCertificatesResponse

    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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



391
392
393
394
395
396
397
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
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 391

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
  call_metadata = @config.rpcs.list_certificates.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_certificates.timeout,
                         metadata:     call_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.list_certificates request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_dns_authorizations(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse #list_dns_authorizations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse

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::Rest::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) ⇒ ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse

    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) ⇒ ::Google::Cloud::CertificateManager::V1::ListDnsAuthorizationsResponse

    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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1724

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
  call_metadata = @config.rpcs.list_dns_authorizations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_dns_authorizations.timeout,
                         metadata:     call_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.list_dns_authorizations request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_trust_configs(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListTrustConfigsResponse #list_trust_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListTrustConfigsResponse

Lists TrustConfigs 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::Rest::Client.new

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

# Call the list_trust_configs method.
result = client.list_trust_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::TrustConfig.
  p item
end

Overloads:

  • #list_trust_configs(request, options = nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListTrustConfigsResponse

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

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::ListTrustConfigsRequest, ::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_trust_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::CertificateManager::V1::ListTrustConfigsResponse

    Pass arguments to list_trust_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 TrustConfigs should be listed, specified in the format projects/*/locations/*.

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

      Maximum number of TrustConfigs to return per call.

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

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

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

      Filter expression to restrict the TrustConfigs returned.

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

      A list of TrustConfig 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2519

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

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

  # 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
  call_metadata = @config.rpcs.list_trust_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_trust_configs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_trust_configs.retry_policy

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

  @certificate_manager_stub.list_trust_configs request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


249
250
251
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 249

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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 650

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
  call_metadata = @config.rpcs.update_certificate.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_certificate.timeout,
                         metadata:     call_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.update_certificate request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1092

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
  call_metadata = @config.rpcs.update_certificate_map.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_certificate_map.timeout,
                         metadata:     call_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.update_certificate_map request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1541
1542
1543
1544
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
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1541

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
  call_metadata = @config.rpcs.update_certificate_map_entry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_certificate_map_entry.timeout,
                         metadata:     call_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.update_certificate_map_entry request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1983

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
  call_metadata = @config.rpcs.update_dns_authorization.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_dns_authorization.timeout,
                         metadata:     call_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.update_dns_authorization request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_trust_config(request, options = nil) ⇒ ::Gapic::Operation #update_trust_config(trust_config: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates a TrustConfig.

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::Rest::Client.new

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

# Call the update_trust_config method.
result = client.update_trust_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:

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

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

    Parameters:

    • request (::Google::Cloud::CertificateManager::V1::UpdateTrustConfigRequest, ::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_trust_config(trust_config: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_trust_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:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
 
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 2779

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

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

  # 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
  call_metadata = @config.rpcs.update_trust_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_trust_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_trust_config.retry_policy

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

  @certificate_manager_stub.update_trust_config request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end