google-cloud-asset 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131f4e3b99876f0dcc9c2e50170fbed12807a8708698291fae64475fce3d61a6
-  data.tar.gz: d14bfb95f02c0eae45262695363ad716f2a658585ab849ec21205041be538ae0
+  metadata.gz: 0b823afc43c96272ec4d02e1d5f4396a522e5e81c5b27fb63e6e4935ee80d0ad
+  data.tar.gz: 374a449c5410e6342ed2e12c1051042d94c41ad0c13c14d1ef71536e613c5886
 SHA512:
-  metadata.gz: 022c28f49005b021f847fdf021f37a5fa86de90cbb7a6296254da0127388f429c27f2979903cdba7008943f46cd8817637eec96546b601058ba8b18dd9beed30
-  data.tar.gz: e9984641139190ab078cc0b0a0984f0913d070572822c51ec37388949de4ed206d4a15ff34df112cabe9bd40b51284ab4bff184bd4011da98b70aede8c3cb83e
+  metadata.gz: 12ee04691bc7f3ae7d3199b7adbda4d78e0a0adf4e78c2c643652018b40f912a09f94eb3fc1da2504315097d2c086dc6c8e41cfdd3b668eacbe5221df659e51a
+  data.tar.gz: aecc97f0ae21e4928cba3a990879ba4ba14583964382fefff23e445f386a6acdfc55b32e15ced8c1d56afc6546c2364d826db3b04ae4575629528b5c7ac91e38

data/README.md

@@ -27,7 +27,7 @@ $ gem install google-cloud-asset
 - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
   to see the full list of Cloud APIs that we cover.
 
-[Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-asset/latest/google/cloud/asset/v1beta1
+[Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-asset/latest/google/cloud/asset/v1
 [Product Documentation]: https://cloud.google.com/asset
 
 ## Enabling Logging

data/lib/google/cloud/asset.rb

@@ -90,7 +90,7 @@ module Google
       # Asset service definition.
       #
       # @param version [Symbol, String]
-      #   The major version of the service to be used. By default :v1beta1
+      #   The major version of the service to be used. By default :v1
       #   is used.
       # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
       #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
@@ -122,7 +122,7 @@ module Google
       #   @param exception_transformer [Proc]
       #     An optional proc that intercepts any exceptions raised during an API call to inject
       #     custom error handling.
-      def self.new(*args, version: :v1beta1, **kwargs)
+      def self.new(*args, version: :v1, **kwargs)
         unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
           raise "The version: #{version} is not available. The available versions " \
             "are: [#{AVAILABLE_VERSIONS.join(", ")}]"

data/lib/google/cloud/asset/v1.rb

@@ -0,0 +1,138 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/asset/v1/asset_service_client"
+require "google/cloud/asset/v1/helpers"
+
+module Google
+  module Cloud
+    module Asset
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for Cloud Asset API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+      #
+      # [Cloud Asset API][Product Documentation]:
+      # The cloud asset API manages the history and inventory of cloud resources.
+      # - [Product Documentation][]
+      #
+      # ## Quick Start
+      # In order to use this library, you first need to go through the following
+      # steps:
+      #
+      # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+      # 3. [Enable the Cloud Asset API.](https://console.cloud.google.com/apis/library/asset.googleapis.com)
+      # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      #
+      # ### Installation
+      # ```
+      # $ gem install google-cloud-asset
+      # ```
+      #
+      # ### Next Steps
+      # - Read the [Cloud Asset API Product documentation][Product Documentation]
+      #   to learn more about the product and see How-to Guides.
+      # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
+      #   to see the full list of Cloud APIs that we cover.
+      #
+      # [Product Documentation]: https://cloud.google.com/asset
+      #
+      # ## Enabling Logging
+      #
+      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+      #
+      # Configuring a Ruby stdlib logger:
+      #
+      # ```ruby
+      # require "logger"
+      #
+      # module MyLogger
+      #   LOGGER = Logger.new $stderr, level: Logger::WARN
+      #   def logger
+      #     LOGGER
+      #   end
+      # end
+      #
+      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+      # module GRPC
+      #   extend MyLogger
+      # end
+      # ```
+      #
+      module V1
+        # rubocop:enable LineLength
+
+        ##
+        # Asset service definition.
+        #
+        # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #   Provides the means for authenticating requests made by the client. This parameter can
+        #   be many types.
+        #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #   authenticating requests made by this client.
+        #   A `String` will be treated as the path to the keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `GRPC::Core::Channel` will be used to make calls through.
+        #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #   should already be composed with a `GRPC::Core::CallCredentials` object.
+        #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #   metadata for requests, generally, to give OAuth credentials.
+        # @param scopes [Array<String>]
+        #   The OAuth scopes for this service. This parameter is ignored if
+        #   an updater_proc is supplied.
+        # @param client_config [Hash]
+        #   A Hash for call options for each method. See
+        #   Google::Gax#construct_settings for the structure of
+        #   this data. Falls back to the default config if not specified
+        #   or the specified config is missing data points.
+        # @param timeout [Numeric]
+        #   The default timeout, in seconds, for calls made through this client.
+        # @param metadata [Hash]
+        #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+        # @param exception_transformer [Proc]
+        #   An optional proc that intercepts any exceptions raised during an API call to inject
+        #   custom error handling.
+        def self.new \
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            metadata: nil,
+            exception_transformer: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            metadata: metadata,
+            exception_transformer: exception_transformer,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::Asset::V1::AssetServiceClient.new(**kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/asset/v1/asset_service_client.rb

@@ -0,0 +1,385 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/cloud/asset/v1/asset_service.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+
+
+require "json"
+require "pathname"
+
+require "google/gax"
+require "google/gax/operation"
+require "google/longrunning/operations_client"
+
+require "google/cloud/asset/v1/asset_service_pb"
+require "google/cloud/asset/v1/credentials"
+
+module Google
+  module Cloud
+    module Asset
+      module V1
+        # Asset service definition.
+        #
+        # @!attribute [r] asset_service_stub
+        #   @return [Google::Cloud::Asset::V1::AssetService::Stub]
+        class AssetServiceClient
+          # @private
+          attr_reader :asset_service_stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "cloudasset.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          # The default set of gRPC interceptors.
+          GRPC_INTERCEPTORS = []
+
+          DEFAULT_TIMEOUT = 30
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_SCOPES = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+
+          # @private
+          class OperationsClient < Google::Longrunning::OperationsClient
+            self::SERVICE_ADDRESS = AssetServiceClient::SERVICE_ADDRESS
+            self::GRPC_INTERCEPTORS = AssetServiceClient::GRPC_INTERCEPTORS
+          end
+
+          PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}"
+          )
+
+          private_constant :PROJECT_PATH_TEMPLATE
+
+          # Returns a fully-qualified project resource name string.
+          # @param project [String]
+          # @return [String]
+          def self.project_path project
+            PROJECT_PATH_TEMPLATE.render(
+              :"project" => project
+            )
+          end
+
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          # @param metadata [Hash]
+          #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+          # @param exception_transformer [Proc]
+          #   An optional proc that intercepts any exceptions raised during an API call to inject
+          #   custom error handling.
+          def initialize \
+              credentials: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              metadata: nil,
+              exception_transformer: nil,
+              lib_name: nil,
+              lib_version: ""
+            # 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 "google/gax/grpc"
+            require "google/cloud/asset/v1/asset_service_services_pb"
+
+            credentials ||= Google::Cloud::Asset::V1::Credentials.default
+
+            @operations_client = OperationsClient.new(
+              credentials: credentials,
+              scopes: scopes,
+              client_config: client_config,
+              timeout: timeout,
+              lib_name: lib_name,
+              lib_version: lib_version,
+            )
+
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::Asset::V1::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
+            end
+
+            package_version = Gem.loaded_specs['google-cloud-asset'].version.version
+
+            google_api_client = "gl-ruby/#{RUBY_VERSION}"
+            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+            google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+            google_api_client << " grpc/#{GRPC::VERSION}"
+            google_api_client.freeze
+
+            headers = { :"x-goog-api-client" => google_api_client }
+            headers.merge!(metadata) unless metadata.nil?
+            client_config_file = Pathname.new(__dir__).join(
+              "asset_service_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.cloud.asset.v1.AssetService",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                metadata: headers
+              )
+            end
+
+            # Allow overriding the service path/port in subclasses.
+            service_path = self.class::SERVICE_ADDRESS
+            port = self.class::DEFAULT_SERVICE_PORT
+            interceptors = self.class::GRPC_INTERCEPTORS
+            @asset_service_stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              updater_proc: updater_proc,
+              scopes: scopes,
+              interceptors: interceptors,
+              &Google::Cloud::Asset::V1::AssetService::Stub.method(:new)
+            )
+
+            @export_assets = Google::Gax.create_api_call(
+              @asset_service_stub.method(:export_assets),
+              defaults["export_assets"],
+              exception_transformer: exception_transformer
+            )
+            @batch_get_assets_history = Google::Gax.create_api_call(
+              @asset_service_stub.method(:batch_get_assets_history),
+              defaults["batch_get_assets_history"],
+              exception_transformer: exception_transformer
+            )
+          end
+
+          # Service calls
+
+          # Exports assets with time and resource types to a given Cloud Storage
+          # location. The output format is newline-delimited JSON.
+          # This API implements the {Google::Longrunning::Operation} API allowing you
+          # to keep track of the export.
+          #
+          # @param parent [String]
+          #   Required. The relative name of the root asset. This can only be an
+          #   organization number (such as "organizations/123"), a project ID (such as
+          #   "projects/my-project-id"), or a project number (such as "projects/12345"),
+          #   or a folder number (such as "folders/123").
+          # @param output_config [Google::Cloud::Asset::V1::OutputConfig | Hash]
+          #   Required. Output configuration indicating where the results will be output
+          #   to. All results will be in newline delimited JSON format.
+          #   A hash of the same form as `Google::Cloud::Asset::V1::OutputConfig`
+          #   can also be provided.
+          # @param read_time [Google::Protobuf::Timestamp | Hash]
+          #   Timestamp to take an asset snapshot. This can only be set to a timestamp
+          #   between 2018-10-02 UTC (inclusive) and the current time. If not specified,
+          #   the current time will be used. Due to delays in resource data collection
+          #   and indexing, there is a volatile window during which running the same
+          #   query may get different results.
+          #   A hash of the same form as `Google::Protobuf::Timestamp`
+          #   can also be provided.
+          # @param asset_types [Array<String>]
+          #   A list of asset types of which to take a snapshot for. For example:
+          #   "compute.googleapis.com/Disk". If specified, only matching assets will be returned.
+          #   See [Introduction to Cloud Asset
+          #   Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
+          #   for all supported asset types.
+          # @param content_type [Google::Cloud::Asset::V1::ContentType]
+          #   Asset content type. If not specified, no content but the asset name will be
+          #   returned.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Gax::Operation]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/asset"
+          #
+          #   asset_client = Google::Cloud::Asset.new(version: :v1)
+          #
+          #   # TODO: Initialize `parent`:
+          #   parent = ''
+          #
+          #   # TODO: Initialize `output_config`:
+          #   output_config = {}
+          #
+          #   # Register a callback during the method call.
+          #   operation = asset_client.export_assets(parent, output_config) do |op|
+          #     raise op.results.message if op.error?
+          #     op_results = op.results
+          #     # Process the results.
+          #
+          #     metadata = op.metadata
+          #     # Process the metadata.
+          #   end
+          #
+          #   # Or use the return value to register a callback.
+          #   operation.on_done do |op|
+          #     raise op.results.message if op.error?
+          #     op_results = op.results
+          #     # Process the results.
+          #
+          #     metadata = op.metadata
+          #     # Process the metadata.
+          #   end
+          #
+          #   # Manually reload the operation.
+          #   operation.reload!
+          #
+          #   # Or block until the operation completes, triggering callbacks on
+          #   # completion.
+          #   operation.wait_until_done!
+
+          def export_assets \
+              parent,
+              output_config,
+              read_time: nil,
+              asset_types: nil,
+              content_type: nil,
+              options: nil
+            req = {
+              parent: parent,
+              output_config: output_config,
+              read_time: read_time,
+              asset_types: asset_types,
+              content_type: content_type
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Asset::V1::ExportAssetsRequest)
+            operation = Google::Gax::Operation.new(
+              @export_assets.call(req, options),
+              @operations_client,
+              Google::Cloud::Asset::V1::ExportAssetsResponse,
+              Google::Cloud::Asset::V1::ExportAssetsRequest,
+              call_options: options
+            )
+            operation.on_done { |operation| yield(operation) } if block_given?
+            operation
+          end
+
+          # Batch gets the update history of assets that overlap a time window.
+          # For RESOURCE content, this API outputs history with asset in both
+          # non-delete or deleted status.
+          # For IAM_POLICY content, this API outputs history when the asset and its
+          # attached IAM POLICY both exist. This can create gaps in the output history.
+          # If a specified asset does not exist, this API returns an INVALID_ARGUMENT
+          # error.
+          #
+          # @param parent [String]
+          #   Required. The relative name of the root asset. It can only be an
+          #   organization number (such as "organizations/123"), a project ID (such as
+          #   "projects/my-project-id")", or a project number (such as "projects/12345").
+          # @param content_type [Google::Cloud::Asset::V1::ContentType]
+          #   Required. The content type.
+          # @param read_time_window [Google::Cloud::Asset::V1::TimeWindow | Hash]
+          #   Optional. The time window for the asset history. Both start_time and
+          #   end_time are optional and if set, it must be after 2018-10-02 UTC. If
+          #   end_time is not set, it is default to current timestamp. If start_time is
+          #   not set, the snapshot of the assets at end_time will be returned. The
+          #   returned results contain all temporal assets whose time window overlap with
+          #   read_time_window.
+          #   A hash of the same form as `Google::Cloud::Asset::V1::TimeWindow`
+          #   can also be provided.
+          # @param asset_names [Array<String>]
+          #   A list of the full names of the assets. For example:
+          #   `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
+          #   See [Resource
+          #   Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
+          #   and [Resource Name Format](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format)
+          #   for more info.
+          #
+          #   The request becomes a no-op if the asset name list is empty, and the max
+          #   size of the asset name list is 100 in one request.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
+          # @return [Google::Cloud::Asset::V1::BatchGetAssetsHistoryResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/asset"
+          #
+          #   asset_client = Google::Cloud::Asset.new(version: :v1)
+          #
+          #   # TODO: Initialize `parent`:
+          #   parent = ''
+          #
+          #   # TODO: Initialize `content_type`:
+          #   content_type = :CONTENT_TYPE_UNSPECIFIED
+          #
+          #   # TODO: Initialize `read_time_window`:
+          #   read_time_window = {}
+          #   response = asset_client.batch_get_assets_history(parent, content_type, read_time_window)
+
+          def batch_get_assets_history \
+              parent,
+              content_type,
+              read_time_window,
+              asset_names: nil,
+              options: nil,
+              &block
+            req = {
+              parent: parent,
+              content_type: content_type,
+              read_time_window: read_time_window,
+              asset_names: asset_names
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Asset::V1::BatchGetAssetsHistoryRequest)
+            @batch_get_assets_history.call(req, options, &block)
+          end
+        end
+      end
+    end
+  end
+end