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

Client for the SecretManagerService service.

Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

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:



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

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:



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

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:

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

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::AccessSecretVersionRequest, 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.

  • #access_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::AccessSecretVersionResponse

    Pass arguments to access_secret_version 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 of the SecretVersion in the format projects/*/secrets/*/versions/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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
819
820
821
822
823
824
825
826
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 791

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.



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 371

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:



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

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:

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

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::CreateSecretRequest, 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_secret(parent: nil, secret_id: nil, secret: nil) ⇒ Google::Cloud::SecretManager::V1::Secret

    Pass arguments to create_secret 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 project to associate with the Secret, in the format projects/*.

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

      Required. This must be unique within the project.

      A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (-) and underscore (_) characters.

    • secret (Google::Cloud::SecretManager::V1::Secret, Hash) (defaults to: nil) —

      Required. A Secret with initial field values.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 301

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:

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

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::DeleteSecretRequest, Hash) —

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

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

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

  • #delete_secret(name: nil) ⇒ Google::Protobuf::Empty

    Pass arguments to delete_secret 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 of the Secret to delete in the format projects/*/secrets/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 572

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:

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

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::DestroySecretVersionRequest, 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.

  • #destroy_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

    Pass arguments to destroy_secret_version 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 of the SecretVersion to destroy in the format projects/*/secrets/*/versions/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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

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:

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

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::DisableSecretVersionRequest, 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.

  • #disable_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

    Pass arguments to disable_secret_version 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 of the SecretVersion to disable in the format projects/*/secrets/*/versions/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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

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:

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

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::EnableSecretVersionRequest, 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_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

    Pass arguments to enable_secret_version 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 of the SecretVersion to enable in the format projects/*/secrets/*/versions/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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

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, options: 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

    Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (Google::Iam::V1::GetIamPolicyRequest, 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_iam_policy(resource: nil, options: nil) ⇒ Google::Iam::V1::Policy

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

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

      REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

    • options (Google::Iam::V1::GetPolicyOptions, Hash) (defaults to: nil) —

      OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



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
1181
1182
1183
1184
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1149

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:

  • #get_secret(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::Secret

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::GetSecretRequest, 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_secret(name: nil) ⇒ Google::Cloud::SecretManager::V1::Secret

    Pass arguments to get_secret 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 of the Secret, in the format projects/*/secrets/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 437

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:

  • #get_secret_version(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::GetSecretVersionRequest, 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_secret_version(name: nil) ⇒ Google::Cloud::SecretManager::V1::SecretVersion

    Pass arguments to get_secret_version 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 of the SecretVersion in the format projects/*/secrets/*/versions/*. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



721
722
723
724
725
726
727
728
729
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
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 721

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>

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::ListSecretVersionsRequest, 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_secret_versions(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::SecretVersion>

    Pass arguments to list_secret_versions 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 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.



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

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>

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::ListSecretsRequest, 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_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ Gapic::PagedEnumerable<Google::Cloud::SecretManager::V1::Secret>

    Pass arguments to list_secrets 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 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.



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
253
254
255
256
257
258
259
260
261
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 225

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

    Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (Google::Iam::V1::SetIamPolicyRequest, 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.

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

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

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

      REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

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



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
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 1078

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

    Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

    Parameters:

    • request (Google::Iam::V1::TestIamPermissionsRequest, 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.

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

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

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

      REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

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



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

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:

  • #update_secret(request, options = nil) ⇒ Google::Cloud::SecretManager::V1::Secret

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

    Parameters:

    • request (Google::Cloud::SecretManager::V1::UpdateSecretRequest, 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_secret(secret: nil, update_mask: nil) ⇒ Google::Cloud::SecretManager::V1::Secret

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

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Cloud::Error) —

    if the RPC is aborted.



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/google/cloud/secret_manager/v1/secret_manager_service/client.rb', line 505

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