Skip to content

feat: add ViewObjectFullContext RPC and RapidCacheInfo in Storage Control v2 #36229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
quartzmo merged 2 commits into from
Aug 12, 2026
Merged

feat: add ViewObjectFullContext RPC and RapidCacheInfo in Storage Control v2 #36229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19d8b91
feat: add ViewObjectFullContext RPC and RapidCacheInfo in Storage Con…
gcf-owl-bot[bot] Aug 11, 2026
c2865ba
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions google-cloud-storage-control-v2/.owlbot-manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
"snippets/storage_control/update_organization_intelligence_config.rb",
"snippets/storage_control/update_project_intelligence_config.rb",
"snippets/storage_control/update_rapid_cache.rb",
"snippets/storage_control/view_object_full_context.rb",
"test/google/cloud/storage/control/v2/storage_control_operations_test.rb",
"test/google/cloud/storage/control/v2/storage_control_paths_test.rb",
"test/google/cloud/storage/control/v2/storage_control_rest_test.rb",
Expand Down
5 changes: 5 additions & 0 deletions google-cloud-storage-control-v2/gapic_metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,11 @@
"methods": [
"list_intelligence_finding_revisions"
]
},
"ViewObjectFullContext": {
"methods": [
"view_object_full_context"
]
}
}
}
Expand Down
109 changes: 109 additions & 0 deletions ...le-cloud-storage-control-v2/lib/google/cloud/storage/control/v2/storage_control/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4041,6 +4041,108 @@ def list_intelligence_finding_revisions request, options = nil
raise ::Google::Cloud::Error.from_error(e)
end

##
# Retrieves the full content of an object context, including its key, value,
# and any associated extended data for a given context key.
#
# Object contexts can optionally contain extended data. If an object context
# contains extended data, the metadata payload structure will contain only
# its type URL. To retrieve the full extended data, call this method.
#
# Returns the complete representation of the context as an
# {::Google::Cloud::Storage::Control::V2::ObjectFullContext `ObjectFullContext`}.
#
# @overload view_object_full_context(request, options = nil)
# Pass arguments to `view_object_full_context` via a request object, either of type
# {::Google::Cloud::Storage::Control::V2::ViewObjectFullContextRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Storage::Control::V2::ViewObjectFullContextRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload view_object_full_context(generation: nil, context_key: nil, name: nil)
# Pass arguments to `view_object_full_context` 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).
#
# @param generation [::Integer]
# Optional. If present, selects a specific revision of this object (as
# opposed to the latest version, the default).
# @param context_key [::String]
# Required. The key of the object context to retrieve.
# @param name [::String]
# Required. The name of the object.
# Format: `projects/{project}/buckets/{bucket}/objects/{object}`
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Storage::Control::V2::ObjectFullContext]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::Storage::Control::V2::ObjectFullContext]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example 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::ViewObjectFullContextRequest.new
#
# # Call the view_object_full_context method.
# result = client.view_object_full_context request
#
# # The returned object is of type Google::Cloud::Storage::Control::V2::ObjectFullContext.
# p result
#
def view_object_full_context request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?

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

# 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.view_object_full_context.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/[^/]+)(?:/(?<__wildcard__>.*))?$}.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.view_object_full_context.timeout,
metadata: metadata,
retry_policy: @config.rpcs.view_object_full_context.retry_policy

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

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

##
# Configuration class for the StorageControl API.
#
Expand Down Expand Up @@ -4411,6 +4513,11 @@ class Rpcs
# @return [::Gapic::Config::Method]
#
attr_reader :list_intelligence_finding_revisions
##
# RPC-specific configuration for `view_object_full_context`
# @return [::Gapic::Config::Method]
#
attr_reader :view_object_full_context

# @private
def initialize parent_rpcs = nil
Expand Down Expand Up @@ -4488,6 +4595,8 @@ def initialize parent_rpcs = nil
@get_intelligence_finding_revision = ::Gapic::Config::Method.new get_intelligence_finding_revision_config
list_intelligence_finding_revisions_config = parent_rpcs.list_intelligence_finding_revisions if parent_rpcs.respond_to? :list_intelligence_finding_revisions
@list_intelligence_finding_revisions = ::Gapic::Config::Method.new list_intelligence_finding_revisions_config
view_object_full_context_config = parent_rpcs.view_object_full_context if parent_rpcs.respond_to? :view_object_full_context
@view_object_full_context = ::Gapic::Config::Method.new view_object_full_context_config

yield self if block_given?
end
Expand Down
19 changes: 19 additions & 0 deletions google-cloud-storage-control-v2/lib/google/cloud/storage/control/v2/storage_control/paths.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,25 @@ def managed_folder_path project:, bucket:, managed_folder:
"projects/#{project}/buckets/#{bucket}/managedFolders/#{managed_folder}"
end

##
# Create a fully-qualified Object resource string.
#
# The resource will be in the following format:
#
# `projects/{project}/buckets/{bucket}/objects/{object}`
#
# @param project [String]
# @param bucket [String]
# @param object [String]
#
# @return [::String]
def object_path project:, bucket:, object:
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
raise ::ArgumentError, "bucket cannot contain /" if bucket.to_s.include? "/"

"projects/#{project}/buckets/#{bucket}/objects/#{object}"
end

##
# Create a fully-qualified RapidCache resource string.
#
Expand Down
99 changes: 99 additions & 0 deletions ...oud-storage-control-v2/lib/google/cloud/storage/control/v2/storage_control/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1927,6 +1927,98 @@ def list_intelligence_finding_revisions request, options = nil
raise ::Google::Cloud::Error.from_error(e)
end

##
# Retrieves the full content of an object context, including its key, value,
# and any associated extended data for a given context key.
#
# Object contexts can optionally contain extended data. If an object context
# contains extended data, the metadata payload structure will contain only
# its type URL. To retrieve the full extended data, call this method.
#
# Returns the complete representation of the context as an
# {::Google::Cloud::Storage::Control::V2::ObjectFullContext `ObjectFullContext`}.
#
# @overload view_object_full_context(request, options = nil)
# Pass arguments to `view_object_full_context` via a request object, either of type
# {::Google::Cloud::Storage::Control::V2::ViewObjectFullContextRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Storage::Control::V2::ViewObjectFullContextRequest, ::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.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @overload view_object_full_context(generation: nil, context_key: nil, name: nil)
# Pass arguments to `view_object_full_context` 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).
#
# @param generation [::Integer]
# Optional. If present, selects a specific revision of this object (as
# opposed to the latest version, the default).
# @param context_key [::String]
# Required. The key of the object context to retrieve.
# @param name [::String]
# Required. The name of the object.
# Format: `projects/{project}/buckets/{bucket}/objects/{object}`
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Storage::Control::V2::ObjectFullContext]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Storage::Control::V2::ObjectFullContext]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example 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::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Storage::Control::V2::ViewObjectFullContextRequest.new
#
# # Call the view_object_full_context method.
# result = client.view_object_full_context request
#
# # The returned object is of type Google::Cloud::Storage::Control::V2::ObjectFullContext.
# p result
#
def view_object_full_context request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?

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

# 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
call_metadata = @config.rpcs.view_object_full_context.metadata.to_h

# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
call_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,
transports_version_send: [:rest]

call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

options.apply_defaults timeout: @config.rpcs.view_object_full_context.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.view_object_full_context.retry_policy

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

@storage_control_stub.view_object_full_context request, options do |result, operation|
yield result, operation if block_given?
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end

##
# Configuration class for the StorageControl REST API.
#
Expand Down Expand Up @@ -2165,6 +2257,11 @@ class Rpcs
# @return [::Gapic::Config::Method]
#
attr_reader :list_intelligence_finding_revisions
##
# RPC-specific configuration for `view_object_full_context`
# @return [::Gapic::Config::Method]
#
attr_reader :view_object_full_context

# @private
def initialize parent_rpcs = nil
Expand Down Expand Up @@ -2204,6 +2301,8 @@ def initialize parent_rpcs = nil
@get_intelligence_finding_revision = ::Gapic::Config::Method.new get_intelligence_finding_revision_config
list_intelligence_finding_revisions_config = parent_rpcs.list_intelligence_finding_revisions if parent_rpcs.respond_to? :list_intelligence_finding_revisions
@list_intelligence_finding_revisions = ::Gapic::Config::Method.new list_intelligence_finding_revisions_config
view_object_full_context_config = parent_rpcs.view_object_full_context if parent_rpcs.respond_to? :view_object_full_context
@view_object_full_context = ::Gapic::Config::Method.new view_object_full_context_config

yield self if block_given?
end
Expand Down
Loading
Loading