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

#bucket_path, #folder_path, #managed_folder_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:



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

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
  )
end

Instance Attribute Details

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

Get the associated client for long-running operations.

Returns:



209
210
211
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 209

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
 
# 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.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, 4, 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, 4, 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, 4, 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, 4, 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, 4, 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, 4, 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:



127
128
129
130
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 127

def configure
  yield @config if block_given?
  @config
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.



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

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?
    return response
  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.



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 901

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?
    return 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.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 373

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?
    return 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.



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1003

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?
    return response
  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.



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 473

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?
    return response
  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.



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1103

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?
    return response
  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.



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 801

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?
    return 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.



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

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?
    return 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.



1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 1208

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?
    return response
  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.



704
705
706
707
708
709
710
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
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 704

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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


137
138
139
 
# File 'lib/google/cloud/storage/control/v2/storage_control/client.rb', line 137

def universe_domain
  @storage_control_stub.universe_domain
end