Class: Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb

Overview

Client for the CertificateAuthorityService service.

Certificate Authority Service manages private certificate authorities and issued certificates.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#certificate_authority_path, #certificate_path, #certificate_revocation_list_path, #location_path, #reusable_config_path

Constructor Details

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

Create a new CertificateAuthorityService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CertificateAuthorityService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 131

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

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

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

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

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

  @certificate_authority_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



183
184
185
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 183

def operations_client
  @operations_client
end

Class Method Details

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

Configure the CertificateAuthorityService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CertificateAuthorityService clients
::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 64

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Security", "PrivateCA", "V1beta1"]
    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.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#activate_certificate_authority(request, options = nil) ⇒ ::Gapic::Operation #activate_certificate_authority(name: nil, pem_ca_certificate: nil, subordinate_config: nil, request_id: nil) ⇒ ::Gapic::Operation

Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::ActivateCertificateAuthorityRequest.new

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

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

Overloads:

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

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

    Parameters:

  • #activate_certificate_authority(name: nil, pem_ca_certificate: nil, subordinate_config: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to activate_certificate_authority 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. The resource name for this CertificateAuthority in the format projects/*/locations/*/certificateAuthorities/*.

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

      Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.

    • subordinate_config (::Google::Cloud::Security::PrivateCA::V1beta1::SubordinateConfig, ::Hash) (defaults to: nil) —

      Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 777

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::ActivateCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

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

Configure the CertificateAuthorityService 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:



101
102
103
104
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 101

def configure
  yield @config if block_given?
  @config
end

#create_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate #create_certificate(parent: nil, certificate_id: nil, certificate: nil, request_id: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

Create a new Certificate in a given Project, Location from a particular CertificateAuthority.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::Certificate.
p result

Overloads:

  • #create_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::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, request_id: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

    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 resource name of the location and CertificateAuthority associated with the Certificate, in the format projects/*/locations/*/certificateAuthorities/*.

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

      Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is optional and its value is ignored otherwise.

    • certificate (::Google::Cloud::Security::PrivateCA::V1beta1::Certificate, ::Hash) (defaults to: nil) —

      Required. A Certificate with initial field values.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



255
256
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
294
295
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 255

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#create_certificate_authority(request, options = nil) ⇒ ::Gapic::Operation #create_certificate_authority(parent: nil, certificate_authority_id: nil, certificate_authority: nil, request_id: nil) ⇒ ::Gapic::Operation

Create a new CertificateAuthority in a given Project and Location.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateAuthorityRequest.new

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

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

Overloads:

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

    Pass arguments to create_certificate_authority via a request object, either of type Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateAuthorityRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateAuthorityRequest, ::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_authority(parent: nil, certificate_authority_id: nil, certificate_authority: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_certificate_authority 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 resource name of the location associated with the CertificateAuthorities, in the format projects/*/locations/*.

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

      Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

    • certificate_authority (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority, ::Hash) (defaults to: nil) —

      Required. A CertificateAuthority with initial field values.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



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
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 892

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::CreateCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

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

Disable a CertificateAuthority.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::DisableCertificateAuthorityRequest.new

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

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

Overloads:

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

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

    Parameters:

  • #disable_certificate_authority(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to disable_certificate_authority 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. The resource name for this CertificateAuthority in the format projects/*/locations/*/certificateAuthorities/*.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1001

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::DisableCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

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

Enable a CertificateAuthority.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::EnableCertificateAuthorityRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::EnableCertificateAuthorityRequest, ::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.

  • #enable_certificate_authority(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to enable_certificate_authority 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. The resource name for this CertificateAuthority in the format projects/*/locations/*/certificateAuthorities/*.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1110

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::EnableCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#fetch_certificate_authority_csr(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::FetchCertificateAuthorityCsrResponse #fetch_certificate_authority_csr(name: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::FetchCertificateAuthorityCsrResponse

Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::FetchCertificateAuthorityCsrRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::FetchCertificateAuthorityCsrResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1204

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::FetchCertificateAuthorityCsrRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#get_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate #get_certificate(name: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

Returns a Certificate.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::GetCertificateRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::Certificate.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



341
342
343
344
345
346
347
348
349
350
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
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 341

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::GetCertificateRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#get_certificate_authority(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority #get_certificate_authority(name: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority

Returns a CertificateAuthority.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::GetCertificateAuthorityRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1291

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::GetCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#get_certificate_revocation_list(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList #get_certificate_revocation_list(name: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList

Returns a CertificateRevocationList.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::GetCertificateRevocationListRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1813

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::GetCertificateRevocationListRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#get_reusable_config(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig #get_reusable_config(name: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig

Returns a ReusableConfig.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::GetReusableConfigRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig.
p result

Overloads:

  • #get_reusable_config(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::GetReusableConfigRequest, ::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_reusable_config(name: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig

    Pass arguments to get_reusable_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. The [name][ReusableConfigs.name] of the [ReusableConfigs][] to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 2116

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::GetReusableConfigRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#list_certificate_authorities(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority> #list_certificate_authorities(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority>

Lists CertificateAuthorities.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::ListCertificateAuthoritiesRequest.new

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

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1397

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificateAuthoritiesRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#list_certificate_revocation_lists(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList> #list_certificate_revocation_lists(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList>

Lists CertificateRevocationLists.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::ListCertificateRevocationListsRequest.new

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

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1919

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificateRevocationListsRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

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

Lists Certificates.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::ListCertificatesRequest.new

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

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

Overloads:

  • #list_certificates(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::Certificate>

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificatesRequest, ::Hash) —

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

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

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

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

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

    Parameters:

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

      Required. The resource name of the location associated with the Certificates, in the format projects/*/locations/*/certificateauthorities/*.

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

      Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

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

      Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.

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

      Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.

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

      Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 451

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::ListCertificatesRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#list_reusable_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig> #list_reusable_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig>

Lists ReusableConfigs.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsRequest.new

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

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

Overloads:

  • #list_reusable_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig>

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsRequest, ::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_reusable_configs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Security::PrivateCA::V1beta1::ReusableConfig>

    Pass arguments to list_reusable_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 resource name of the location associated with the ReusableConfigs, in the format projects/*/locations/*.

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

      Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

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

      Optional. Pagination token, returned earlier via ListReusableConfigsResponse.next_page_token.

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

      Optional. Only include resources that match the filter in the response.

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

      Optional. Specify how the results should be sorted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 2222

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::ListReusableConfigsRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

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

Restore a CertificateAuthority that is scheduled for deletion.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::RestoreCertificateAuthorityRequest.new

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

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

Overloads:

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

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

    Parameters:

  • #restore_certificate_authority(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to restore_certificate_authority 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. The resource name for this CertificateAuthority in the format projects/*/locations/*/certificateAuthorities/*.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



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
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1506

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::RestoreCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#revoke_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate #revoke_certificate(name: nil, reason: nil, request_id: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

Revoke a Certificate.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::RevokeCertificateRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::Certificate.
p result

Overloads:

  • #revoke_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::RevokeCertificateRequest, ::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.

  • #revoke_certificate(name: nil, reason: nil, request_id: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

    Pass arguments to revoke_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. The resource name for this Certificate in the format projects/*/locations/*/certificateAuthorities/*/certificates/*.

    • reason (::Google::Cloud::Security::PrivateCA::V1beta1::RevocationReason) (defaults to: nil) —

      Required. The RevocationReason for revoking this certificate.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 555

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::RevokeCertificateRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

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

Schedule a CertificateAuthority for deletion.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::ScheduleDeleteCertificateAuthorityRequest.new

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

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

Overloads:

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

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

    Parameters:

  • #schedule_delete_certificate_authority(name: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to schedule_delete_certificate_authority 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. The resource name for this CertificateAuthority in the format projects/*/locations/*/certificateAuthorities/*.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1615

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::ScheduleDeleteCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 111

def universe_domain
  @certificate_authority_service_stub.universe_domain
end

#update_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate #update_certificate(certificate: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

Update a Certificate. Currently, the only field you can update is the labels field.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateRequest.new

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

# The returned object is of type Google::Cloud::Security::PrivateCA::V1beta1::Certificate.
p result

Overloads:

  • #update_certificate(request, options = nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::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, request_id: nil) ⇒ ::Google::Cloud::Security::PrivateCA::V1beta1::Certificate

    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:

    • certificate (::Google::Cloud::Security::PrivateCA::V1beta1::Certificate, ::Hash) (defaults to: nil) —

      Required. Certificate with updated values.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. A list of fields to be updated in this request.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 658

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#update_certificate_authority(request, options = nil) ⇒ ::Gapic::Operation #update_certificate_authority(certificate_authority: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

Update a CertificateAuthority.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateAuthorityRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateAuthorityRequest, ::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_authority(certificate_authority: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

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

    • certificate_authority (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthority, ::Hash) (defaults to: nil) —

      Required. CertificateAuthority with updated values.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. A list of fields to be updated in this request.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 1725

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateAuthorityRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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

#update_certificate_revocation_list(request, options = nil) ⇒ ::Gapic::Operation #update_certificate_revocation_list(certificate_revocation_list: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

Update a CertificateRevocationList.

Examples:

Basic example

require "google/cloud/security/private_ca/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Security::PrivateCA::V1beta1::CertificateAuthorityService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateRevocationListRequest.new

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

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

Overloads:

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

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

    Parameters:

  • #update_certificate_revocation_list(certificate_revocation_list: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

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

    • certificate_revocation_list (::Google::Cloud::Security::PrivateCA::V1beta1::CertificateRevocationList, ::Hash) (defaults to: nil) —

      Required. CertificateRevocationList with updated values.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. A list of fields to be updated in this request.

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

      Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

      For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/google/cloud/security/private_ca/v1beta1/certificate_authority_service/client.rb', line 2029

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Security::PrivateCA::V1beta1::UpdateCertificateRevocationListRequest

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

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Security::PrivateCA::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

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