Class: Google::Apis::CertificatemanagerV1::CertificateManagerService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/certificatemanager_v1/service.rb

Overview

Certificate Manager API

Examples:

require 'google/apis/certificatemanager_v1'

Certificatemanager = Google::Apis::CertificatemanagerV1 # Alias the module
service = Certificatemanager::CertificateManagerService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CertificateManagerService

Returns a new instance of CertificateManagerService.



45
46
47
48
49
50
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 45

def initialize
  super('https://certificatemanager.googleapis.com/', '',
        client_name: 'google-apis-certificatemanager_v1',
        client_version: Google::Apis::CertificatemanagerV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::CertificatemanagerV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 1047

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_certificate(parent, certificate_object = nil, certificate_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Creates a new Certificate in a given project and location.

Parameters:

  • parent (String) —

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

  • certificate_object (Google::Apis::CertificatemanagerV1::Certificate) (defaults to: nil)
  • certificate_id (String) (defaults to: nil) —

    Required. A user-provided name of the certificate.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 673

def create_project_location_certificate(parent, certificate_object = nil, certificate_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/certificates', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::Certificate::Representation
  command.request_object = certificate_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['certificateId'] = certificate_id unless certificate_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_certificate_issuance_config(parent, certificate_issuance_config_object = nil, certificate_issuance_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Creates a new CertificateIssuanceConfig in a given project and location.

Parameters:

  • parent (String) —

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

  • certificate_issuance_config_object (Google::Apis::CertificatemanagerV1::CertificateIssuanceConfig) (defaults to: nil)
  • certificate_issuance_config_id (String) (defaults to: nil) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 149

def create_project_location_certificate_issuance_config(parent, certificate_issuance_config_object = nil, certificate_issuance_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/certificateIssuanceConfigs', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::CertificateIssuanceConfig::Representation
  command.request_object = certificate_issuance_config_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['certificateIssuanceConfigId'] = certificate_issuance_config_id unless certificate_issuance_config_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_certificate_map(parent, certificate_map_object = nil, certificate_map_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Creates a new CertificateMap in a given project and location.

Parameters:

  • parent (String) —

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

  • certificate_map_object (Google::Apis::CertificatemanagerV1::CertificateMap) (defaults to: nil)
  • certificate_map_id (String) (defaults to: nil) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 296

def create_project_location_certificate_map(parent, certificate_map_object = nil, certificate_map_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/certificateMaps', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::CertificateMap::Representation
  command.request_object = certificate_map_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['certificateMapId'] = certificate_map_id unless certificate_map_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_certificate_map_certificate_map_entry(parent, certificate_map_entry_object = nil, certificate_map_entry_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Creates a new CertificateMapEntry in a given project and location.

Parameters:

  • parent (String) —

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

  • certificate_map_entry_object (Google::Apis::CertificatemanagerV1::CertificateMapEntry) (defaults to: nil)
  • certificate_map_entry_id (String) (defaults to: nil) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 483

def create_project_location_certificate_map_certificate_map_entry(parent, certificate_map_entry_object = nil, certificate_map_entry_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/certificateMapEntries', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::CertificateMapEntry::Representation
  command.request_object = certificate_map_entry_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['certificateMapEntryId'] = certificate_map_entry_id unless certificate_map_entry_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dns_authorization(parent, dns_authorization_object = nil, dns_authorization_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Creates a new DnsAuthorization in a given project and location.

Parameters:

  • parent (String) —

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

  • dns_authorization_object (Google::Apis::CertificatemanagerV1::DnsAuthorization) (defaults to: nil)
  • dns_authorization_id (String) (defaults to: nil) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 858

def create_project_location_dns_authorization(parent, dns_authorization_object = nil, dns_authorization_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dnsAuthorizations', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::DnsAuthorization::Representation
  command.request_object = dns_authorization_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['dnsAuthorizationId'] = dns_authorization_id unless dns_authorization_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_certificate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Deletes a single Certificate.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



707
708
709
710
711
712
713
714
715
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 707

def delete_project_location_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_certificate_issuance_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Deletes a single CertificateIssuanceConfig.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



183
184
185
186
187
188
189
190
191
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 183

def delete_project_location_certificate_issuance_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_certificate_map(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::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.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



332
333
334
335
336
337
338
339
340
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 332

def delete_project_location_certificate_map(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_certificate_map_certificate_map_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Deletes a single CertificateMapEntry.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



517
518
519
520
521
522
523
524
525
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 517

def delete_project_location_certificate_map_certificate_map_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dns_authorization(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Deletes a single DnsAuthorization.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



892
893
894
895
896
897
898
899
900
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 892

def delete_project_location_dns_authorization(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1082
1083
1084
1085
1086
1087
1088
1089
1090
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 1082

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Location

Gets information about a location.

Parameters:

  • name (String) —

    Resource name for the location.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



72
73
74
75
76
77
78
79
80
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 72

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Location::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_certificate(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Certificate

Gets details of a single Certificate.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



738
739
740
741
742
743
744
745
746
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 738

def get_project_location_certificate(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Certificate::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Certificate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_certificate_issuance_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::CertificateIssuanceConfig

Gets details of a single CertificateIssuanceConfig.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



214
215
216
217
218
219
220
221
222
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 214

def get_project_location_certificate_issuance_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::CertificateIssuanceConfig::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::CertificateIssuanceConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_certificate_map(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::CertificateMap

Gets details of a single CertificateMap.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



363
364
365
366
367
368
369
370
371
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 363

def get_project_location_certificate_map(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::CertificateMap::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::CertificateMap
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_certificate_map_certificate_map_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::CertificateMapEntry

Gets details of a single CertificateMapEntry.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



548
549
550
551
552
553
554
555
556
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 548

def get_project_location_certificate_map_certificate_map_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::CertificateMapEntry::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::CertificateMapEntry
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dns_authorization(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::DnsAuthorization

Gets details of a single DnsAuthorization.

Parameters:

  • name (String) —

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



923
924
925
926
927
928
929
930
931
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 923

def get_project_location_dns_authorization(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::DnsAuthorization::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::DnsAuthorization
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 1113

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_certificate_issuance_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListCertificateIssuanceConfigsResponse

Lists CertificateIssuanceConfigs in a given project and location.

Parameters:

  • parent (String) —

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

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

  • page_size (Fixnum) (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.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 258

def list_project_location_certificate_issuance_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/certificateIssuanceConfigs', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListCertificateIssuanceConfigsResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListCertificateIssuanceConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_certificate_map_certificate_map_entries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListCertificateMapEntriesResponse

Lists CertificateMapEntries in a given project and location.

Parameters:

  • parent (String) —

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

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

  • page_size (Fixnum) (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.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 595

def list_project_location_certificate_map_certificate_map_entries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/certificateMapEntries', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListCertificateMapEntriesResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListCertificateMapEntriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_certificate_maps(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListCertificateMapsResponse

Lists CertificateMaps in a given project and location.

Parameters:

  • parent (String) —

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

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

  • page_size (Fixnum) (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.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 406

def list_project_location_certificate_maps(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/certificateMaps', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListCertificateMapsResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListCertificateMapsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_certificates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListCertificatesResponse

Lists Certificates in a given project and location.

Parameters:

  • parent (String) —

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

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

  • page_size (Fixnum) (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.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 781

def list_project_location_certificates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/certificates', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListCertificatesResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListCertificatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dns_authorizations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListDnsAuthorizationsResponse

Lists DnsAuthorizations in a given project and location.

Parameters:

  • parent (String) —

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

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

  • page_size (Fixnum) (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.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 966

def list_project_location_dns_authorizations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dnsAuthorizations', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListDnsAuthorizationsResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListDnsAuthorizationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

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

    The standard list filter.

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

    The standard list page size.

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

    The standard list page token.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 1156

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String) —

    The resource that owns the locations collection, if applicable.

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

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

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

    The maximum number of results to return. If not set, the service selects a default.

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

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 112

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::CertificatemanagerV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_certificate(name, certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Updates a Certificate.

Parameters:

  • name (String) —

    A user-defined name of the certificate. Certificate names must be unique globally and match pattern projects/*/locations/*/certificates/*.

  • certificate_object (Google::Apis::CertificatemanagerV1::Certificate) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 821

def patch_project_location_certificate(name, certificate_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::Certificate::Representation
  command.request_object = certificate_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_certificate_map(name, certificate_map_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Updates a CertificateMap.

Parameters:

  • name (String) —

    A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern projects/*/locations/*/certificateMaps/*.

  • certificate_map_object (Google::Apis::CertificatemanagerV1::CertificateMap) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 446

def patch_project_location_certificate_map(name, certificate_map_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::CertificateMap::Representation
  command.request_object = certificate_map_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_certificate_map_certificate_map_entry(name, certificate_map_entry_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Updates a CertificateMapEntry.

Parameters:

  • name (String) —

    A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern projects/*/locations/*/ certificateMaps/*/certificateMapEntries/*.

  • certificate_map_entry_object (Google::Apis::CertificatemanagerV1::CertificateMapEntry) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 636

def patch_project_location_certificate_map_certificate_map_entry(name, certificate_map_entry_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::CertificateMapEntry::Representation
  command.request_object = certificate_map_entry_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dns_authorization(name, dns_authorization_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CertificatemanagerV1::Operation

Updates a DnsAuthorization.

Parameters:

  • name (String) —

    A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern projects/*/locations/*/dnsAuthorizations/*.

  • dns_authorization_object (Google::Apis::CertificatemanagerV1::DnsAuthorization) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/ google.protobuf#fieldmask.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'lib/google/apis/certificatemanager_v1/service.rb', line 1006

def patch_project_location_dns_authorization(name, dns_authorization_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::CertificatemanagerV1::DnsAuthorization::Representation
  command.request_object = dns_authorization_object
  command.response_representation = Google::Apis::CertificatemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CertificatemanagerV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end