Class: Google::Cloud::SecretManager::V1::SecretManagerService::Client

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

Overview

Service that implements SecretManagerService API.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#project_path, #secret_path, #secret_version_path

Constructor Details

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

Create a new SecretManagerService client object.

Examples

To create a new SecretManagerService client with the default configuration:

client = Google::Cloud::SecretManager::V1::SecretManagerService::Client.new

To create a new SecretManagerService client with a custom configuration:

client = Google::Cloud::SecretManager::V1::SecretManagerService::Client.new do |config|
  config.timeout = 10_000
end

Yields:

  • (config) —

    Configure the SecretManagerService client.

Yield Parameters:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 154

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/secretmanager/v1/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
  credentials ||= Credentials.default scope: @config.scope
  if credentials.is_a?(String) || credentials.is_a?(Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil

  @secret_manager_service_stub = Gapic::ServiceStub.new(
    Google::Cloud::SecretManager::V1::SecretManagerService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

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

Configure the SecretManagerService Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all SecretManagerService clients:

Google::Cloud::SecretManager::V1::SecretManagerService::Client.configure do |config|
  config.timeout = 10_000
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 61

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

    default_config.rpcs.list_secrets.timeout = 60.0

    default_config.rpcs.create_secret.timeout = 60.0

    default_config.rpcs.add_secret_version.timeout = 60.0

    default_config.rpcs.get_secret.timeout = 60.0

    default_config.rpcs.update_secret.timeout = 60.0

    default_config.rpcs.delete_secret.timeout = 60.0

    default_config.rpcs.list_secret_versions.timeout = 60.0

    default_config.rpcs.get_secret_version.timeout = 60.0

    default_config.rpcs.access_secret_version.timeout = 60.0
    default_config.rpcs.access_secret_version.retry_policy = {
      initial_delay: 1.0,
      max_delay:     60.0,
      multiplier:    1.3,
      retry_codes:   ["UNAVAILABLE", "UNKNOWN"]
    }

    default_config.rpcs.disable_secret_version.timeout = 60.0

    default_config.rpcs.enable_secret_version.timeout = 60.0

    default_config.rpcs.destroy_secret_version.timeout = 60.0

    default_config.rpcs.set_iam_policy.timeout = 60.0

    default_config.rpcs.get_iam_policy.timeout = 60.0

    default_config.rpcs.test_iam_permissions.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#access_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::AccessSecretVersionResponse #access_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::AccessSecretVersionResponse

Accesses a SecretVersion. This call returns the secret data.

projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 730

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::AccessSecretVersionRequest

  # 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.access_secret_version.metadata.to_h

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

  header_params = {
    "name" => request.name
  }
  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.access_secret_version.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.access_secret_version.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :access_secret_version, 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

#add_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion #add_secret_version(parent: nil, payload: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 345

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::AddSecretVersionRequest

  # 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.add_secret_version.metadata.to_h

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

  header_params = {
    "parent" => request.parent
  }
  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.add_secret_version.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.add_secret_version.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :add_secret_version, 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

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

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



129
130
131
132
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 129

def configure
  yield @config if block_given?
  @config
end

#create_secret(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::Secret #create_secret(parent: nil, secret_id: nil, secret: nil) ⇒ Google::Cloud::SecretManager::V1::Secret

Creates a new Secret containing no SecretVersions.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 281

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::CreateSecretRequest

  # 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_secret.metadata.to_h

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

  header_params = {
    "parent" => request.parent
  }
  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_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_secret.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :create_secret, 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

#delete_secret(request, options = nil) ⇒ Google::Protobuf::Empty #delete_secret(name: nil) ⇒ Google::Protobuf::Empty

Deletes a Secret.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 525

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::DeleteSecretRequest

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

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

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

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

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

  @secret_manager_service_stub.call_rpc :delete_secret, 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

#destroy_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion #destroy_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

Destroys a SecretVersion.

Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 930

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::DestroySecretVersionRequest

  # 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.destroy_secret_version.metadata.to_h

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

  header_params = {
    "name" => request.name
  }
  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.destroy_secret_version.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.destroy_secret_version.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :destroy_secret_version, 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

#disable_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion #disable_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

Disables a SecretVersion.

Sets the state of the SecretVersion to DISABLED.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 796

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::DisableSecretVersionRequest

  # 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_secret_version.metadata.to_h

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

  header_params = {
    "name" => request.name
  }
  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_secret_version.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.disable_secret_version.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :disable_secret_version, 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

#enable_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion #enable_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

Enables a SecretVersion.

Sets the state of the SecretVersion to ENABLED.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 862

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::EnableSecretVersionRequest

  # 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_secret_version.metadata.to_h

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

  header_params = {
    "name" => request.name
  }
  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_secret_version.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.enable_secret_version.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :enable_secret_version, 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_iam_policy(request, options = nil) ⇒ Google::Iam::V1::Policy #get_iam_policy(resource: nil) ⇒ Google::Iam::V1::Policy

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

Overloads:

  • #get_iam_policy(request, options = nil) ⇒ Google::Iam::V1::Policy

    Parameters:

    • request (Google::Iam::V1::GetIamPolicyRequest | Hash) —

      Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

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

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

  • #get_iam_policy(resource: nil) ⇒ Google::Iam::V1::Policy

    Parameters:

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

      REQUIRED: The resource for which the policy is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1067

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

  request = Gapic::Protobuf.coerce request, to: Google::Iam::V1::GetIamPolicyRequest

  # 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_iam_policy.metadata.to_h

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

  header_params = {
    "resource" => request.resource
  }
  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_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_iam_policy.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :get_iam_policy, 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_secret(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::Secret #get_secret(name: nil) ⇒ Google::Cloud::SecretManager::V1::Secret

Gets metadata for a given Secret.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::GetSecretRequest

  # 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_secret.metadata.to_h

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

  header_params = {
    "name" => request.name
  }
  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_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_secret.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :get_secret, 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_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion #get_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

Gets metadata for a SecretVersion.

projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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
699
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 664

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::GetSecretVersionRequest

  # 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_secret_version.metadata.to_h

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

  header_params = {
    "name" => request.name
  }
  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_secret_version.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_secret_version.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :get_secret_version, 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_secret_versions(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::SecretVersion> #list_secret_versions(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::SecretVersion>

Lists SecretVersions. This call does not return secret data.

Overloads:

  • #list_secret_versions(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::SecretVersion>

    Parameters:

  • #list_secret_versions(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::SecretVersion>

    Parameters:

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

      Required. The resource name of the Secret associated with the SecretVersions to list, in the format projects/*/secrets/*.

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

      Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

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

      Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 595

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::ListSecretVersionsRequest

  # 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_secret_versions.metadata.to_h

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

  header_params = {
    "parent" => request.parent
  }
  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_secret_versions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_secret_versions.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :list_secret_versions, request, options: options do |response, operation|
    response = Gapic::PagedEnumerable.new @secret_manager_service_stub, :list_secret_versions, 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_secrets(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::Secret> #list_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::Secret>

Lists Secrets.

Overloads:

  • #list_secrets(request, options = nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::Secret>

    Parameters:

  • #list_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::Secret>

    Parameters:

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

      Required. The resource name of the project associated with the Secrets, in the format projects/*.

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

      Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 216

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::ListSecretsRequest

  # 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_secrets.metadata.to_h

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

  header_params = {
    "parent" => request.parent
  }
  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_secrets.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_secrets.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :list_secrets, request, options: options do |response, operation|
    response = Gapic::PagedEnumerable.new @secret_manager_service_stub, :list_secrets, 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

#set_iam_policy(request, options = nil) ⇒ Google::Iam::V1::Policy #set_iam_policy(resource: nil, policy: nil) ⇒ Google::Iam::V1::Policy

Sets the access control policy on the specified secret. Replaces any existing policy.

Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

Overloads:

  • #set_iam_policy(request, options = nil) ⇒ Google::Iam::V1::Policy

    Parameters:

    • request (Google::Iam::V1::SetIamPolicyRequest | Hash) —

      Sets the access control policy on the specified secret. Replaces any existing policy.

      Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

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

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

  • #set_iam_policy(resource: nil, policy: nil) ⇒ Google::Iam::V1::Policy

    Parameters:

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

      REQUIRED: The resource for which the policy is being specified. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

    • policy (Google::Iam::V1::Policy | Hash) (defaults to: nil) —

      REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1004

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

  request = Gapic::Protobuf.coerce request, to: Google::Iam::V1::SetIamPolicyRequest

  # 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.set_iam_policy.metadata.to_h

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

  header_params = {
    "resource" => request.resource
  }
  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.set_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_iam_policy.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :set_iam_policy, 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

#test_iam_permissions(request, options = nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse #test_iam_permissions(resource: nil, permissions: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Overloads:

  • #test_iam_permissions(request, options = nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

    Parameters:

    • request (Google::Iam::V1::TestIamPermissionsRequest | Hash) —

      Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error.

      Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

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

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

  • #test_iam_permissions(resource: nil, permissions: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

    Parameters:

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

      REQUIRED: The resource for which the policy detail is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

    • permissions (Array<String>) (defaults to: nil) —

      The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1145

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

  request = Gapic::Protobuf.coerce request, to: Google::Iam::V1::TestIamPermissionsRequest

  # 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.test_iam_permissions.metadata.to_h

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

  header_params = {
    "resource" => request.resource
  }
  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.test_iam_permissions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.test_iam_permissions.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :test_iam_permissions, 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_secret(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::Secret #update_secret(secret: nil, update_mask: nil) ⇒ Google::Cloud::SecretManager::V1::Secret

Updates metadata of an existing Secret.

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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
493
494
495
496
497
498
499
500
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 465

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

  request = Gapic::Protobuf.coerce request, to: Google::Cloud::SecretManager::V1::UpdateSecretRequest

  # 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_secret.metadata.to_h

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

  header_params = {
    "secret.name" => request.secret.name
  }
  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_secret.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_secret.retry_policy
  options.apply_defaults metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @secret_manager_service_stub.call_rpc :update_secret, 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