Class: Google::Cloud::Storage::Control::V2::StorageControl::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/storage/control/v2/storage_control/client.rb

Overview

Client for the StorageControl service.

StorageControl service includes selected control plane operations.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#anywhere_cache_path, #bucket_path, #folder_path, #intelligence_config_path, #intelligence_finding_path, #intelligence_finding_revision_path, #location_path, #managed_folder_path, #rapid_cache_path, #storage_layout_path

Constructor Details

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

Create a new StorageControl client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the StorageControl client.

Yield Parameters:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 257

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/storage/control/v2/storage_control_services_pb"

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

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

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

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

  @storage_control_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Storage::Control::V2::StorageControl::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
  )

  @storage_control_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
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Storage::Control::V2::StorageControl::Operations (readonly)

Get the associated client for long-running operations.

Returns:



320
321
322
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 320

def operations_client
  @operations_client
end

Class Method Details

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

Configure the StorageControl Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all StorageControl clients
::Google::Cloud::Storage::Control::V2::StorageControl::Client.configure do |config|
  config.timeout = 10.0
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
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
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 63

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

    default_config.timeout = 60.0

    default_config.rpcs.create_folder.timeout = 60.0
    default_config.rpcs.create_folder.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_folder.timeout = 60.0
    default_config.rpcs.get_folder.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.list_folders.timeout = 60.0
    default_config.rpcs.list_folders.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.rename_folder.timeout = 60.0
    default_config.rpcs.rename_folder.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.delete_folder_recursive.timeout = 60.0
    default_config.rpcs.delete_folder_recursive.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_storage_layout.timeout = 60.0
    default_config.rpcs.get_storage_layout.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_managed_folder.timeout = 60.0
    default_config.rpcs.get_managed_folder.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.list_managed_folders.timeout = 60.0
    default_config.rpcs.list_managed_folders.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.create_anywhere_cache.timeout = 60.0
    default_config.rpcs.create_anywhere_cache.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.update_anywhere_cache.timeout = 60.0
    default_config.rpcs.update_anywhere_cache.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.disable_anywhere_cache.timeout = 60.0
    default_config.rpcs.disable_anywhere_cache.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.pause_anywhere_cache.timeout = 60.0
    default_config.rpcs.pause_anywhere_cache.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.resume_anywhere_cache.timeout = 60.0
    default_config.rpcs.resume_anywhere_cache.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_anywhere_cache.timeout = 60.0
    default_config.rpcs.get_anywhere_cache.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.list_anywhere_caches.timeout = 60.0
    default_config.rpcs.list_anywhere_caches.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_project_intelligence_config.timeout = 60.0
    default_config.rpcs.get_project_intelligence_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.update_project_intelligence_config.timeout = 60.0
    default_config.rpcs.update_project_intelligence_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_folder_intelligence_config.timeout = 60.0
    default_config.rpcs.get_folder_intelligence_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.update_folder_intelligence_config.timeout = 60.0
    default_config.rpcs.update_folder_intelligence_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_organization_intelligence_config.timeout = 60.0
    default_config.rpcs.get_organization_intelligence_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.update_organization_intelligence_config.timeout = 60.0
    default_config.rpcs.update_organization_intelligence_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_intelligence_finding.timeout = 60.0
    default_config.rpcs.get_intelligence_finding.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.list_intelligence_findings.timeout = 60.0
    default_config.rpcs.list_intelligence_findings.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.summarize_intelligence_findings.timeout = 60.0
    default_config.rpcs.summarize_intelligence_findings.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.get_intelligence_finding_revision.timeout = 60.0
    default_config.rpcs.get_intelligence_finding_revision.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config.rpcs.list_intelligence_finding_revisions.timeout = 60.0
    default_config.rpcs.list_intelligence_finding_revisions.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [8, 14, 13, 2]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

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



227
228
229
230
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 227

def configure
  yield @config if block_given?
  @config
end

#create_anywhere_cache(request, options = nil) ⇒ ::Gapic::Operation #create_anywhere_cache(parent: nil, anywhere_cache: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates an Anywhere Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::CreateAnywhereCacheRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::CreateAnywhereCacheRequest, ::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_anywhere_cache(parent: nil, anywhere_cache: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_anywhere_cache 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 bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}

    • anywhere_cache (::Google::Cloud::Storage::Control::V2::AnywhereCache, ::Hash) (defaults to: nil) —

      Required. Properties of the Anywhere Cache instance being created. The parent bucket name is specified in the parent field. Server uses the default value of ttl or admission_policy if not specified in request.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1643

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::CreateAnywhereCacheRequest

  # 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_anywhere_cache.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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

#create_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder #create_folder(parent: nil, folder: nil, folder_id: nil, recursive: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::CreateFolderRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::Folder.
p result

Overloads:

  • #create_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::CreateFolderRequest, ::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_folder(parent: nil, folder: nil, folder_id: nil, recursive: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder

    Pass arguments to create_folder 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. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

    • folder (::Google::Cloud::Storage::Control::V2::Folder, ::Hash) (defaults to: nil) —

      Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

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

      Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

    • recursive (::Boolean) (defaults to: nil) —

      Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
435
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 396

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::CreateFolderRequest

  # 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_folder.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :create_folder, 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

#create_managed_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder #create_managed_folder(parent: nil, managed_folder: nil, managed_folder_id: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

Creates a new managed folder.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::CreateManagedFolderRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::ManagedFolder.
p result

Overloads:

  • #create_managed_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::CreateManagedFolderRequest, ::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_managed_folder(parent: nil, managed_folder: nil, managed_folder_id: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

    Pass arguments to create_managed_folder 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. Name of the bucket this managed folder belongs to.

    • managed_folder (::Google::Cloud::Storage::Control::V2::ManagedFolder, ::Hash) (defaults to: nil) —

      Required. Properties of the managed folder being created. The bucket and managed folder names are specified in the parent and managed_folder_id fields. Populating these fields in managed_folder will result in an error.

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

      Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::CreateManagedFolderRequest

  # 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_managed_folder.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :create_managed_folder, 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

#create_rapid_cache(request, options = nil) ⇒ ::Gapic::Operation #create_rapid_cache(parent: nil, rapid_cache: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a Rapid Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::CreateRapidCacheRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::CreateRapidCacheRequest, ::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_rapid_cache(parent: nil, rapid_cache: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_rapid_cache 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 bucket to which this cache belongs. Format: projects/{project}/buckets/{bucket}

    • rapid_cache (::Google::Cloud::Storage::Control::V2::RapidCache, ::Hash) (defaults to: nil) —

      Required. The RapidCache to create. Default values for ingest_on_write, ttl and admission_policy will be applied if not specified in the request.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2331

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::CreateRapidCacheRequest

  # 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_rapid_cache.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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

#delete_folder(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Protobuf::Empty

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::DeleteFolderRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::DeleteFolderRequest, ::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_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_folder 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. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

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

      Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.

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

      Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
528
529
530
531
532
533
534
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 492

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::DeleteFolderRequest

  # 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_folder.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :delete_folder, 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_folder_recursive(request, options = nil) ⇒ ::Gapic::Operation #delete_folder_recursive(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Gapic::Operation

Deletes a folder recursively. This operation is only applicable to a hierarchical namespace enabled bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest, ::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_folder_recursive(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_folder_recursive 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. Name of the folder being deleted, however all of its contents will be deleted too. Format: projects/{project}/buckets/{bucket}/folders/{folder}

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

      Optional. Makes the operation only succeed conditional on whether the root folder's current metageneration matches the given value.

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

      Optional. Makes the operation only succeed conditional on whether the root folder's current metageneration does not match the given value.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 930

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::DeleteFolderRecursiveRequest

  # 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_folder_recursive.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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

#delete_managed_folder(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, allow_non_empty: nil, request_id: nil) ⇒ ::Google::Protobuf::Empty

Permanently deletes an empty managed folder.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::DeleteManagedFolderRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::DeleteManagedFolderRequest, ::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_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, allow_non_empty: nil, request_id: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_managed_folder 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. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

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

      The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.

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

      The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.

    • allow_non_empty (::Boolean) (defaults to: nil) —

      Allows deletion of a managed folder even if it is not empty. A managed folder is empty if it manages no child managed folders or objects. Caller must have permission for storage.managedFolders.setIamPolicy.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

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
1263
1264
1265
1266
1267
1268
1269
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1227

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::DeleteManagedFolderRequest

  # 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_managed_folder.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :delete_managed_folder, 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_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache #disable_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

Disables an Anywhere Cache instance. A disabled instance is read-only. The disablement could be revoked by calling ResumeAnywhereCache. The cache instance will be deleted automatically if it remains in the disabled state for at least one hour.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::DisableAnywhereCacheRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::AnywhereCache.
p result

Overloads:

  • #disable_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::DisableAnywhereCacheRequest, ::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_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

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

      Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1850

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::DisableAnywhereCacheRequest

  # 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_anywhere_cache.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :disable_anywhere_cache, 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_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache #get_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

Gets an Anywhere Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetAnywhereCacheRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::AnywhereCache.
p result

Overloads:

  • #get_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetAnywhereCacheRequest, ::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_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

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

      Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2128

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetAnywhereCacheRequest

  # 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_anywhere_cache.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :get_anywhere_cache, 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_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder #get_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder

Returns metadata for the specified folder. This operation is only applicable to a hierarchical namespace enabled bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetFolderRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::Folder.
p result

Overloads:

  • #get_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetFolderRequest, ::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_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::Folder

    Pass arguments to get_folder 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. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

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

      Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.

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

      Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 591

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetFolderRequest

  # 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_folder.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :get_folder, 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_folder_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig #get_folder_intelligence_config(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Returns the Folder scoped singleton IntelligenceConfig resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetFolderIntelligenceConfigRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
p result

Overloads:

  • #get_folder_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetFolderIntelligenceConfigRequest, ::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_folder_intelligence_config(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

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

      Required. The name of the IntelligenceConfig resource associated with your folder.

      Format: folders/{id}/locations/global/intelligenceConfig

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2904

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetFolderIntelligenceConfigRequest

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Storage::Control::V2::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_folder_intelligence_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_folder_intelligence_config.retry_policy

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

  @storage_control_stub.call_rpc :get_folder_intelligence_config, 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 IAM policy for a specified bucket. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::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.



3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3269

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::Storage::Control::V2::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 && !request.resource.empty?
    header_params["bucket"] = request.resource
  end
  if request.resource
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.resource
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  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

  @storage_control_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_intelligence_finding(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFinding #get_intelligence_finding(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFinding

Gets the IntelligenceFinding for a project.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceFinding.
p result

Overloads:

  • #get_intelligence_finding(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFinding

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRequest, ::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_intelligence_finding(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFinding

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

    Parameters:

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

      Required. The name of the IntelligenceFinding resource.

      Format: projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3579

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRequest

  # 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_intelligence_finding.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::Storage::Control::V2::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_intelligence_finding.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_intelligence_finding.retry_policy

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

  @storage_control_stub.call_rpc :get_intelligence_finding, 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_intelligence_finding_revision(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision #get_intelligence_finding_revision(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision

Gets the IntelligenceFindingRevision resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRevisionRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision.
p result

Overloads:

  • #get_intelligence_finding_revision(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRevisionRequest, ::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_intelligence_finding_revision(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision

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

    Parameters:

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

      Required. The name of the IntelligenceFindingRevision resource.

      Format:

      projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}/revisions/{revision}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3899

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetIntelligenceFindingRevisionRequest

  # 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_intelligence_finding_revision.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::Storage::Control::V2::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_intelligence_finding_revision.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_intelligence_finding_revision.retry_policy

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

  @storage_control_stub.call_rpc :get_intelligence_finding_revision, 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_managed_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder #get_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

Returns metadata for the specified managed folder.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetManagedFolderRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::ManagedFolder.
p result

Overloads:

  • #get_managed_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetManagedFolderRequest, ::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_managed_folder(name: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

    Pass arguments to get_managed_folder 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. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}

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

      The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.

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

      The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1326

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetManagedFolderRequest

  # 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_managed_folder.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :get_managed_folder, 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_organization_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig #get_organization_intelligence_config(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Returns the Organization scoped singleton IntelligenceConfig resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetOrganizationIntelligenceConfigRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
p result

Overloads:

  • #get_organization_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetOrganizationIntelligenceConfigRequest, ::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_organization_intelligence_config(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

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

      Required. The name of the IntelligenceConfig resource associated with your organization.

      Format: organizations/{org_id}/locations/global/intelligenceConfig

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3084

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetOrganizationIntelligenceConfigRequest

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Storage::Control::V2::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_organization_intelligence_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_organization_intelligence_config.retry_policy

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

  @storage_control_stub.call_rpc :get_organization_intelligence_config, 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_project_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig #get_project_intelligence_config(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Returns the Project scoped singleton IntelligenceConfig resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetProjectIntelligenceConfigRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
p result

Overloads:

  • #get_project_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetProjectIntelligenceConfigRequest, ::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_project_intelligence_config(name: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

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

      Required. The name of the IntelligenceConfig resource associated with your project.

      Format: projects/{id}/locations/global/intelligenceConfig

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2724

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetProjectIntelligenceConfigRequest

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Storage::Control::V2::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_project_intelligence_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_project_intelligence_config.retry_policy

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

  @storage_control_stub.call_rpc :get_project_intelligence_config, 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_rapid_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::RapidCache #get_rapid_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::RapidCache

Gets a Rapid Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetRapidCacheRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::RapidCache.
p result

Overloads:

  • #get_rapid_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::RapidCache

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetRapidCacheRequest, ::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_rapid_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::RapidCache

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

    Parameters:

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

      Required. The name field in the request should be: projects/{project}/buckets/{bucket}/rapidCaches/{rapid_cache}

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2533

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetRapidCacheRequest

  # 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_rapid_cache.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :get_rapid_cache, 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_storage_layout(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::StorageLayout #get_storage_layout(name: nil, prefix: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::StorageLayout

Returns the storage layout configuration for a given bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::StorageLayout.
p result

Overloads:

  • #get_storage_layout(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::StorageLayout

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest, ::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_storage_layout(name: nil, prefix: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::StorageLayout

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

    Parameters:

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

      Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout

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

      An optional prefix used for permission check. It is useful when the caller only has limited permissions under a specific prefix.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
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
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1027

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::GetStorageLayoutRequest

  # 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_storage_layout.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :get_storage_layout, 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_anywhere_caches(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::AnywhereCache> #list_anywhere_caches(parent: nil, page_size: nil, page_token: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::AnywhereCache>

Lists Anywhere Cache instances for a given bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListAnywhereCachesRequest.new

# Call the list_anywhere_caches method.
result = client.list_anywhere_caches 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::Storage::Control::V2::AnywhereCache.
  p item
end

Overloads:

  • #list_anywhere_caches(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::AnywhereCache>

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ListAnywhereCachesRequest, ::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_anywhere_caches(parent: nil, page_size: nil, page_token: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::AnywhereCache>

    Pass arguments to list_anywhere_caches 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 bucket to which this cache belongs.

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

      Maximum number of caches to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

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

      A previously-returned page token representing part of the larger set of results to view.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2229

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListAnywhereCachesRequest

  # 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_anywhere_caches.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :list_anywhere_caches, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_control_stub, :list_anywhere_caches, 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_folders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder> #list_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, delimiter: nil, lexicographic_start: nil, lexicographic_end: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListFoldersRequest.new

# Call the list_folders method.
result = client.list_folders 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::Storage::Control::V2::Folder.
  p item
end

Overloads:

  • #list_folders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ListFoldersRequest, ::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_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, delimiter: nil, lexicographic_start: nil, lexicographic_end: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::Folder>

    Pass arguments to list_folders 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. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.

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

      Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

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

      Optional. A previously-returned page token representing part of the larger set of results to view.

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

      Optional. Filter results to folders whose names begin with this prefix. If set, the value must either be an empty string or end with a '/'.

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

      Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.

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

      Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

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

      Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



711
712
713
714
715
716
717
718
719
720
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
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 711

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListFoldersRequest

  # 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_folders.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :list_folders, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_control_stub, :list_folders, 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_intelligence_finding_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision> #list_intelligence_finding_revisions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>

Lists all the revisions of an IntelligenceFinding resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListIntelligenceFindingRevisionsRequest.new

# Call the list_intelligence_finding_revisions method.
result = client.list_intelligence_finding_revisions 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::Storage::Control::V2::IntelligenceFindingRevision.
  p item
end

Overloads:

  • #list_intelligence_finding_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ListIntelligenceFindingRevisionsRequest, ::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_intelligence_finding_revisions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFindingRevision>

    Pass arguments to list_intelligence_finding_revisions 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 parent of the IntelligenceFindingRevision resource.

      Format:

      projects/{project}/locations/{location}/intelligenceFindings/{intelligence_finding}

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

      Optional. The maximum number of IntelligenceFindingRevision resources to return.

      The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

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

      Optional. A page token, received from a previous ListIntelligenceFindingRevisions call. Provide this to retrieve the subsequent page.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 4001

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListIntelligenceFindingRevisionsRequest

  # 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_intelligence_finding_revisions.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::Storage::Control::V2::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_intelligence_finding_revisions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_intelligence_finding_revisions.retry_policy

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

  @storage_control_stub.call_rpc :list_intelligence_finding_revisions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_control_stub, :list_intelligence_finding_revisions, 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_intelligence_findings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding> #list_intelligence_findings(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>

Lists the IntelligenceFinding resources for the specified the project.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListIntelligenceFindingsRequest.new

# Call the list_intelligence_findings method.
result = client.list_intelligence_findings 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::Storage::Control::V2::IntelligenceFinding.
  p item
end

Overloads:

  • #list_intelligence_findings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ListIntelligenceFindingsRequest, ::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_intelligence_findings(parent: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::IntelligenceFinding>

    Pass arguments to list_intelligence_findings 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 parent of the IntelligenceFinding resource.

      Format: projects/{project}/locations/{location}

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

      Optional. The filter expression to be applied. Supports filtering by type and associated_resources.

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

      Optional. The maximum number of IntelligenceFinding resources to return.

      The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

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

      Optional. A page token, received from a previous ListIntelligenceFindings call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListIntelligenceFindings must match the call that provided the 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.



3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3685

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListIntelligenceFindingsRequest

  # 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_intelligence_findings.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::Storage::Control::V2::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_intelligence_findings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_intelligence_findings.retry_policy

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

  @storage_control_stub.call_rpc :list_intelligence_findings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_control_stub, :list_intelligence_findings, 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_managed_folders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder> #list_managed_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>

Retrieves a list of managed folders for a given bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListManagedFoldersRequest.new

# Call the list_managed_folders method.
result = client.list_managed_folders 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::Storage::Control::V2::ManagedFolder.
  p item
end

Overloads:

  • #list_managed_folders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ListManagedFoldersRequest, ::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_managed_folders(parent: nil, page_size: nil, page_token: nil, prefix: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::ManagedFolder>

    Pass arguments to list_managed_folders 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. Name of the bucket this managed folder belongs to.

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

      Optional. Maximum number of managed folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

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

      Optional. A previously-returned page token representing part of the larger set of results to view.

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

      Optional. Filter results to match managed folders with name starting with this prefix.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1430

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListManagedFoldersRequest

  # 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_managed_folders.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :list_managed_folders, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @storage_control_stub, :list_managed_folders, 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_rapid_caches(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::RapidCache> #list_rapid_caches(parent: nil, page_size: nil, page_token: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::RapidCache>

Lists Rapid Cache instances for a given bucket.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ListRapidCachesRequest.new

# Call the list_rapid_caches method.
result = client.list_rapid_caches 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::Storage::Control::V2::RapidCache.
  p item
end

Overloads:

  • #list_rapid_caches(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::RapidCache>

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ListRapidCachesRequest, ::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_rapid_caches(parent: nil, page_size: nil, page_token: nil, request_id: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::RapidCache>

    Pass arguments to list_rapid_caches 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 bucket to which this cache belongs.

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

      Maximum number of caches to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

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

      A previously-returned page token representing part of the larger set of results to view.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2634

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ListRapidCachesRequest

  # 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_rapid_caches.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::Storage::Control::V2::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 && !request.parent.empty?
    header_params["bucket"] = request.parent
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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


327
328
329
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 327

def logger
  @storage_control_stub.logger
end

#pause_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache #pause_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

Pauses an Anywhere Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::PauseAnywhereCacheRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::AnywhereCache.
p result

Overloads:

  • #pause_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::PauseAnywhereCacheRequest, ::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.

  • #pause_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

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

      Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1943

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::PauseAnywhereCacheRequest

  # 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.pause_anywhere_cache.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :pause_anywhere_cache, 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

#rename_folder(request, options = nil) ⇒ ::Gapic::Operation #rename_folder(name: nil, destination_folder_id: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Gapic::Operation

Renames a source folder to a destination folder. This operation is only applicable to a hierarchical namespace enabled bucket. During a rename, the source and destination folders are locked until the long running operation completes.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::RenameFolderRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::RenameFolderRequest, ::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.

  • #rename_folder(name: nil, destination_folder_id: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to rename_folder 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. Name of the source folder being renamed. Format: projects/{project}/buckets/{bucket}/folders/{folder}

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

      Required. The destination folder ID, e.g. foo/bar/.

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

      Makes the operation only succeed conditional on whether the source folder's current metageneration matches the given value.

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

      Makes the operation only succeed conditional on whether the source folder's current metageneration does not match the given value.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 821

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::RenameFolderRequest

  # 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.rename_folder.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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

#resume_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache #resume_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

Resumes a disabled or paused Anywhere Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::ResumeAnywhereCacheRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::AnywhereCache.
p result

Overloads:

  • #resume_anywhere_cache(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::ResumeAnywhereCacheRequest, ::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.

  • #resume_anywhere_cache(name: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::AnywhereCache

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

    Parameters:

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

      Required. The name field in the request should be: projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2036

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::ResumeAnywhereCacheRequest

  # 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.resume_anywhere_cache.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::Storage::Control::V2::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
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :resume_anywhere_cache, 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

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

Updates an IAM policy for the specified bucket. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::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.



3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3376

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::Storage::Control::V2::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 && !request.resource.empty?
    header_params["bucket"] = request.resource
  end
  if request.resource
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.resource
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  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

  @storage_control_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

#summarize_intelligence_findings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary> #summarize_intelligence_findings(parent: nil, resource_scope: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>

Summarizes the intelligence findings for the specified scope (organization, folder or project).

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest.new

# Call the summarize_intelligence_findings method.
result = client.summarize_intelligence_findings 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::Storage::Control::V2::FindingSummary.
  p item
end

Overloads:

  • #summarize_intelligence_findings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>

    Pass arguments to summarize_intelligence_findings via a request object, either of type Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest, ::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.

  • #summarize_intelligence_findings(parent: nil, resource_scope: nil, filter: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Storage::Control::V2::FindingSummary>

    Pass arguments to summarize_intelligence_findings 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 scope to summarize the findings for. Format:

      • organizations/{organization}/locations/{location}
      • folders/{folder}/locations/{location}
      • projects/{project}/locations/{location}
    • resource_scope (::Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest::ResourceScope) (defaults to: nil) —

      Optional. Determines the granularity of the findings when the parent is an organization or folder.

      • PARENT (or not set): A single summary is returned for each insight type, aggregated across the entire parent scope.
      • PROJECT: A separate summary is returned for each insight type for every project within the parent scope.

      The only supported values are PARENT and PROJECT. If no value is specified, the API behaviour defaults to the PARENT.

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

      Optional. The filter expression, following AIP-160. Supports filtering by FindingType.

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

      Optional. The maximum number of findings to return.

      The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

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

      Optional. A page token, received from a previous SummarizeIntelligenceFindings call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to SummarizeIntelligenceFindings must match the call that provided the 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.



3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3809

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::SummarizeIntelligenceFindingsRequest

  # 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.summarize_intelligence_findings.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::Storage::Control::V2::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.summarize_intelligence_findings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.summarize_intelligence_findings.retry_policy

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

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

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

Tests a set of permissions on the given bucket, object, or managed folder to see which, if any, are held by the caller. The resource field in the request should be projects/_/buckets/{bucket} for a bucket, projects/_/buckets/{bucket}/objects/{object} for an object, or projects/_/buckets/{bucket}/managedFolders/{managedFolder} for a managed folder.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::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.



3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3479

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::Storage::Control::V2::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 && !request.resource.empty?
    header_params["bucket"] = request.resource
  end
  if request.resource
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)/objects(?:/.*)?$}.match request.resource
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end
  if request.resource
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)/managedFolders(?:/.*)?$}.match request.resource
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  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

  @storage_control_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) 


237
238
239
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 237

def universe_domain
  @storage_control_stub.universe_domain
end

#update_anywhere_cache(request, options = nil) ⇒ ::Gapic::Operation #update_anywhere_cache(anywhere_cache: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates an Anywhere Cache instance. Mutable fields include ttl and admission_policy.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::UpdateAnywhereCacheRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::UpdateAnywhereCacheRequest, ::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_anywhere_cache(anywhere_cache: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

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

    • anywhere_cache (::Google::Cloud::Storage::Control::V2::AnywhereCache, ::Hash) (defaults to: nil) —

      Required. The Anywhere Cache instance to be updated.

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

      Required. List of fields to be updated. Mutable fields of AnywhereCache include ttl and admission_policy.

      To specify ALL fields, specify a single field with the value *. Note: We recommend against doing this. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field's value.

      Not specifying any fields is an error.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1752

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::UpdateAnywhereCacheRequest

  # 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_anywhere_cache.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::Storage::Control::V2::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.anywhere_cache&.name
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.anywhere_cache.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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

#update_folder_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig #update_folder_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Updates the Folder scoped singleton IntelligenceConfig resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::UpdateFolderIntelligenceConfigRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
p result

Overloads:

  • #update_folder_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::UpdateFolderIntelligenceConfigRequest, ::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_folder_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • intelligence_config (::Google::Cloud::Storage::Control::V2::IntelligenceConfig, ::Hash) (defaults to: nil) —

      Required. The IntelligenceConfig resource to be updated.

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

      Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

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

      Optional. The ID that uniquely identifies the request, preventing duplicate processing.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2996

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::UpdateFolderIntelligenceConfigRequest

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Storage::Control::V2::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.intelligence_config&.name
    header_params["intelligence_config.name"] = request.intelligence_config.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_folder_intelligence_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_folder_intelligence_config.retry_policy

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

  @storage_control_stub.call_rpc :update_folder_intelligence_config, 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

#update_managed_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder #update_managed_folder(managed_folder: nil, update_mask: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

Updates a managed folder. Currently, this RPC only supports updating the rapid_cache_config field.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::UpdateManagedFolderRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::ManagedFolder.
p result

Overloads:

  • #update_managed_folder(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::UpdateManagedFolderRequest, ::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_managed_folder(managed_folder: nil, update_mask: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::ManagedFolder

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

    • managed_folder (::Google::Cloud::Storage::Control::V2::ManagedFolder, ::Hash) (defaults to: nil) —

      Required. Properties of the managed folder being updated. Currently, this RPC only supports updating the rapid_cache_config field in managed_folder.

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

      Optional. Update mask for managed_folder. Currently, this RPC only supports updating the rapid_cache_config field in managed_folder. This field also supports update mask for the subfields in the map of rapid_cache_config. The user can specify the update mask for rapid_cache_config.policies and rapid_cache_config.policies.<key>, but patching is not supported for a field within RapidCachePolicy.policies.<key>, like rapid_cache_config.policies.[key].ingest_on_write.

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

      Optional. The operation succeeds conditional on the managed folder's current metageneration matching the value here specified.

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

      Optional. The operation succeeds conditional on the managed folder's current metageneration NOT matching the value here specified.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1538

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::UpdateManagedFolderRequest

  # 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_managed_folder.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::Storage::Control::V2::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.managed_folder&.name
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.managed_folder.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @storage_control_stub.call_rpc :update_managed_folder, 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

#update_organization_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig #update_organization_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Updates the Organization scoped singleton IntelligenceConfig resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::UpdateOrganizationIntelligenceConfigRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
p result

Overloads:

  • #update_organization_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

  • #update_organization_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • intelligence_config (::Google::Cloud::Storage::Control::V2::IntelligenceConfig, ::Hash) (defaults to: nil) —

      Required. The IntelligenceConfig resource to be updated.

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

      Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

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

      Optional. The ID that uniquely identifies the request, preventing duplicate processing.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 3176

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::UpdateOrganizationIntelligenceConfigRequest

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Storage::Control::V2::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.intelligence_config&.name
    header_params["intelligence_config.name"] = request.intelligence_config.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_organization_intelligence_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_organization_intelligence_config.retry_policy

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

  @storage_control_stub.call_rpc :update_organization_intelligence_config, 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

#update_project_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig #update_project_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

Updates the Project scoped singleton IntelligenceConfig resource.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::UpdateProjectIntelligenceConfigRequest.new

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

# The returned object is of type Google::Cloud::Storage::Control::V2::IntelligenceConfig.
p result

Overloads:

  • #update_project_intelligence_config(request, options = nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::UpdateProjectIntelligenceConfigRequest, ::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_project_intelligence_config(intelligence_config: nil, update_mask: nil, request_id: nil) ⇒ ::Google::Cloud::Storage::Control::V2::IntelligenceConfig

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

    Parameters:

    • intelligence_config (::Google::Cloud::Storage::Control::V2::IntelligenceConfig, ::Hash) (defaults to: nil) —

      Required. The IntelligenceConfig resource to be updated.

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

      Required. The update_mask that specifies the fields within the IntelligenceConfig resource that should be modified by this update. Only the listed fields are updated.

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

      Optional. The ID that uniquely identifies the request, preventing duplicate processing.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2816

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::UpdateProjectIntelligenceConfigRequest

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

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Storage::Control::V2::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.intelligence_config&.name
    header_params["intelligence_config.name"] = request.intelligence_config.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_project_intelligence_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_project_intelligence_config.retry_policy

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

  @storage_control_stub.call_rpc :update_project_intelligence_config, 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

#update_rapid_cache(request, options = nil) ⇒ ::Gapic::Operation #update_rapid_cache(rapid_cache: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

Updates a Rapid Cache instance.

Examples:

Basic example

require "google/cloud/storage/control/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Storage::Control::V2::UpdateRapidCacheRequest.new

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Storage::Control::V2::UpdateRapidCacheRequest, ::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_rapid_cache(rapid_cache: nil, update_mask: nil, request_id: nil) ⇒ ::Gapic::Operation

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

    • rapid_cache (::Google::Cloud::Storage::Control::V2::RapidCache, ::Hash) (defaults to: nil) —

      Required. The RapidCache to update.

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

      Required. List of fields to be updated. Mutable fields of RapidCache include ttl, admission_policy and ingest_on_write.

      To specify ALL fields, specify a single field with the value *. Note: We recommend against doing this. If a new field is introduced at a later time, an older client updating with the * may accidentally reset the new field's value.

      Not specifying any fields is an error.

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

      Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 2439

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Storage::Control::V2::UpdateRapidCacheRequest

  # 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_rapid_cache.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::Storage::Control::V2::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.rapid_cache&.name
    regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.rapid_cache.name
    if regex_match
      header_params["bucket"] = regex_match["bucket".to_s]
    end
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

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