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

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:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 257

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 == Client.configure.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
  end

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

  @certificate_manager_stub = ::Google::Cloud::CertificateManager::V1::CertificateManager::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Instance Attribute Details

#location_clientGoogle::Cloud::Location::Locations::Rest::Client (readonly)

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

Returns:

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


307
308
309
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 307

def location_client
  @location_client
end

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

Get the associated client for long-running operations.



300
301
302
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 300

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:



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

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:



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

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.

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.



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 481

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 818

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1499

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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

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

Deletes a single Certificate.

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.



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 612

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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
1928
1929
1930
1931
1932
1933
1934
1935
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1901

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 951

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1293

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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

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

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.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 414

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1770

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 751

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1432

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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

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

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.



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1707

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1032

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 688

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 351

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



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

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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

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

Updates a Certificate.

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.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 548

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 885

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1229

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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.

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.



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
# File 'lib/google/cloud/certificate_manager/v1/certificate_manager/rest/client.rb', line 1566

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

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         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