Class: Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/secret_manager/v1beta1/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

Instance Attribute Summary collapse

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:


# Create a client using the default configuration
client = ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new

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

Yields:

  • (config) —

    Configure the SecretManagerService client.

Yield Parameters:



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 164

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/secrets/v1beta1/service_services_pb"

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

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

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

  @secret_manager_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::SecretManager::V1beta1::SecretManagerService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @secret_manager_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @secret_manager_service_stub.endpoint
    config.universe_domain = @secret_manager_service_stub.universe_domain
    config.logger = @secret_manager_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


228
229
230
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 228

def location_client
  @location_client
end

Class Method Details

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

Configure the SecretManagerService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
115
116
117
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 69

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

    default_config.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: [14, 2]
    }

    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::V1beta1::AccessSecretVersionResponse #access_secret_version(name: nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::AccessSecretVersionResponse

Accesses a SecretVersion. This call returns the secret data.

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::AccessSecretVersionRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::AccessSecretVersionResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1037

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::AddSecretVersionRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 488

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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



134
135
136
137
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 134

def configure
  yield @config if block_given?
  @config
end

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

Creates a new Secret containing no SecretVersions.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::CreateSecretRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::Secret.
p result

Overloads:

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

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

    Parameters:

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



395
396
397
398
399
400
401
402
403
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
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 395

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::SecretManager::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::DeleteSecretRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

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::V1beta1::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.



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 751

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::SecretManager::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Destroys a SecretVersion.

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::DestroySecretVersionRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
p result

Overloads:

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

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

    Parameters:

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



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1311

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Disables a SecretVersion.

Sets the state of the SecretVersion to DISABLED.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::DisableSecretVersionRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
p result

Overloads:

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

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

    Parameters:

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



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1128

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Enables a SecretVersion.

Sets the state of the SecretVersion to ENABLED.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::EnableSecretVersionRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
p result

Overloads:

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

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

    Parameters:

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



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1219

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

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

# The returned object is of type Google::Iam::V1::Policy.
p result

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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1503

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_secret(request, options = nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::Secret #get_secret(name: nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::Secret

Gets metadata for a given Secret.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::GetSecretRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::Secret.
p result

Overloads:

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

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

    Parameters:

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



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
608
609
610
611
612
613
614
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 575

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::SecretManager::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_secret_version(request, options = nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::SecretVersion #get_secret_version(name: nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::SecretVersion

Gets metadata for a SecretVersion.

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::GetSecretVersionRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::SecretVersion.
p result

Overloads:

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

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

    Parameters:

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



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

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_secret_versions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::SecretManager::V1beta1::SecretVersion> #list_secret_versions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::SecretManager::V1beta1::SecretVersion>

Lists SecretVersions. This call does not return secret data.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::ListSecretVersionsRequest.new

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

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

Overloads:

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

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

    Parameters:

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



851
852
853
854
855
856
857
858
859
860
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
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 851

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::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_secrets(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::SecretManager::V1beta1::Secret> #list_secrets(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::SecretManager::V1beta1::Secret>

Lists Secrets.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::ListSecretsRequest.new

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

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

Overloads:

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

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

    Parameters:

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



297
298
299
300
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
337
338
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 297

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::SecretManager::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


235
236
237
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 235

def logger
  @secret_manager_service_stub.logger
end

#set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #set_iam_policy(resource: nil, policy: nil, update_mask: 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.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

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

# The returned object is of type Google::Iam::V1::Policy.
p result

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, update_mask: 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.

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

      OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

      paths: "bindings, etag"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1413

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

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

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

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

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

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.



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 1600

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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


144
145
146
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 144

def universe_domain
  @secret_manager_service_stub.universe_domain
end

#update_secret(request, options = nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::Secret #update_secret(secret: nil, update_mask: nil) ⇒ ::Google::Cloud::SecretManager::V1beta1::Secret

Updates metadata of an existing Secret.

Examples:

Basic example

require "google/cloud/secret_manager/v1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::SecretManager::V1beta1::UpdateSecretRequest.new

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

# The returned object is of type Google::Cloud::SecretManager::V1beta1::Secret.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
700
701
702
703
 
# File 'lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb', line 664

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::SecretManager::V1beta1::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, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::SecretManager::V1beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

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

  options.apply_defaults timeout:      @config.timeout,
                         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?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end