google-cloud-beyond_corp 1.3.1 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6aaea3b7b0e2a17449728198b85119e0b48587c0362fd7282eb8839577931422
4
- data.tar.gz: 6b1340a1d7b453ab2ebdd9e1727c9c97c6249713bffcd435fc55816478df88cc
3
+ metadata.gz: 712313955c67b18cbaf04bf465359f4888adb06a4e8c715d821c4d317d1054b8
4
+ data.tar.gz: f409626c3724b948f602ead71bd02a1b237a8270894d6566f00b277340123595
5
5
  SHA512:
6
- metadata.gz: d6700cd3889d88531e5a12475068ae649fb3e0873d4eb8d0219458cb0cc2a27b98556cb9e394088ee82374f514cb59526da6a74bd3419c20abf12cd5b9c44a3f
7
- data.tar.gz: 72c4e03bc619805b86890b677e9cea41461df041575859c0036141da3844d015b5b8e8a108fcaf65b9a80877306167096b628a26ae5b08e2ce4629d8d6462e46
6
+ metadata.gz: db42f06cb8742660879e9c08fd90b4fdf263401acd135c92f7cfc2fdff8ae4491aad7638704c187b6687c99f64b17d7710d8774eb97ec7c9b153bd08500fccb2
7
+ data.tar.gz: 7901bdd0067a2752e9084b2fbee92658613489f7effcd9f4d77def5420b43b5f76ae44e75f273bf47d5cad531f451e4ef3a9b0f90b514a27cb27be4ac3a303e0
data/README.md CHANGED
@@ -7,7 +7,7 @@ Beyondcorp Enterprise provides identity and context aware access controls for en
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `google-cloud-beyond_corp-app_connections-v*`.
9
9
  The gem `google-cloud-beyond_corp` is the main client library that brings the
10
- verisoned gems in as dependencies, and provides high-level methods for
10
+ versioned gems in as dependencies, and provides high-level methods for
11
11
  constructing clients. More information on versioned clients can be found below
12
12
  in the section titled *Which client should I use?*.
13
13
 
@@ -37,35 +37,42 @@ In order to use this library, you first need to go through the following steps:
37
37
  1. [Enable the API.](https://console.cloud.google.com/apis/library/beyondcorp.googleapis.com)
38
38
  1. {file:AUTHENTICATION.md Set up authentication.}
39
39
 
40
- ## Enabling Logging
41
-
42
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
43
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
44
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
45
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
46
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
47
-
48
- Configuring a Ruby stdlib logger:
49
-
50
- ```ruby
51
- require "logger"
52
-
53
- module MyLogger
54
- LOGGER = Logger.new $stderr, level: Logger::WARN
55
- def logger
56
- LOGGER
57
- end
58
- end
59
-
60
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
61
- module GRPC
62
- extend MyLogger
63
- end
64
- ```
40
+ ## Debug Logging
41
+
42
+ This library comes with opt-in Debug Logging that can help you troubleshoot
43
+ your application's integration with the API. When logging is activated, key
44
+ events such as requests and responses, along with data payloads and metadata
45
+ such as headers and client configuration, are logged to the standard error
46
+ stream.
47
+
48
+ **WARNING:** Client Library Debug Logging includes your data payloads in
49
+ plaintext, which could include sensitive data such as PII for yourself or your
50
+ customers, private keys, or other security data that could be compromising if
51
+ leaked. Always practice good data hygiene with your application logs, and follow
52
+ the principle of least access. Google also recommends that Client Library Debug
53
+ Logging be enabled only temporarily during active debugging, and not used
54
+ permanently in production.
55
+
56
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
57
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
58
+ list of client library gem names. This will select the default logging behavior,
59
+ which writes logs to the standard error stream. On a local workstation, this may
60
+ result in logs appearing on the console. When running on a Google Cloud hosting
61
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
62
+ results in logs appearing alongside your application logs in the
63
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
64
+
65
+ Debug logging also requires that the versioned clients for this service be
66
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
67
+ working, try updating the versioned clients in your bundle or installed gems:
68
+ [google-cloud-beyond_corp-app_connections-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-app_connections-v1/latest),
69
+ [google-cloud-beyond_corp-app_connectors-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-app_connectors-v1/latest),
70
+ [google-cloud-beyond_corp-app_gateways-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-app_gateways-v1/latest),
71
+ [google-cloud-beyond_corp-client_gateways-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-beyond_corp-client_gateways-v1/latest).
65
72
 
66
73
  ## Supported Ruby Versions
67
74
 
68
- This library is supported on Ruby 2.7+.
75
+ This library is supported on Ruby 3.0+.
69
76
 
70
77
  Google provides official support for Ruby versions that are actively supported
71
78
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -57,6 +57,11 @@ module Google
57
57
  # supported by that API version, and the corresponding gem is available, the
58
58
  # appropriate versioned client will be returned.
59
59
  #
60
+ # Raises an exception if the currently installed versioned client gem for the
61
+ # given API version does not support the AppConnectionsService service.
62
+ # You can determine whether the method will succeed by calling
63
+ # {Google::Cloud::BeyondCorp::AppConnections.app_connections_service_available?}.
64
+ #
60
65
  # ## About AppConnectionsService
61
66
  #
62
67
  # API Overview:
@@ -89,6 +94,32 @@ module Google
89
94
  service_module.const_get(:Client).new(&block)
90
95
  end
91
96
 
97
+ ##
98
+ # Determines whether the AppConnectionsService service is supported by the current client.
99
+ # If true, you can retrieve a client object by calling {Google::Cloud::BeyondCorp::AppConnections.app_connections_service}.
100
+ # If false, that method will raise an exception. This could happen if the given
101
+ # API version does not exist or does not support the AppConnectionsService service,
102
+ # or if the versioned client gem needs an update to support the AppConnectionsService service.
103
+ #
104
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
105
+ # Defaults to `:v1`.
106
+ # @return [boolean] Whether the service is available.
107
+ #
108
+ def self.app_connections_service_available? version: :v1
109
+ require "google/cloud/beyond_corp/app_connections/#{version.to_s.downcase}"
110
+ package_name = Google::Cloud::BeyondCorp::AppConnections
111
+ .constants
112
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
113
+ .first
114
+ return false unless package_name
115
+ service_module = Google::Cloud::BeyondCorp::AppConnections.const_get package_name
116
+ return false unless service_module.const_defined? :AppConnectionsService
117
+ service_module = service_module.const_get :AppConnectionsService
118
+ service_module.const_defined? :Client
119
+ rescue ::LoadError
120
+ false
121
+ end
122
+
92
123
  ##
93
124
  # Configure the google-cloud-beyond_corp-app_connections library.
94
125
  #
@@ -57,6 +57,11 @@ module Google
57
57
  # supported by that API version, and the corresponding gem is available, the
58
58
  # appropriate versioned client will be returned.
59
59
  #
60
+ # Raises an exception if the currently installed versioned client gem for the
61
+ # given API version does not support the AppConnectorsService service.
62
+ # You can determine whether the method will succeed by calling
63
+ # {Google::Cloud::BeyondCorp::AppConnectors.app_connectors_service_available?}.
64
+ #
60
65
  # ## About AppConnectorsService
61
66
  #
62
67
  # API Overview:
@@ -89,6 +94,32 @@ module Google
89
94
  service_module.const_get(:Client).new(&block)
90
95
  end
91
96
 
97
+ ##
98
+ # Determines whether the AppConnectorsService service is supported by the current client.
99
+ # If true, you can retrieve a client object by calling {Google::Cloud::BeyondCorp::AppConnectors.app_connectors_service}.
100
+ # If false, that method will raise an exception. This could happen if the given
101
+ # API version does not exist or does not support the AppConnectorsService service,
102
+ # or if the versioned client gem needs an update to support the AppConnectorsService service.
103
+ #
104
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
105
+ # Defaults to `:v1`.
106
+ # @return [boolean] Whether the service is available.
107
+ #
108
+ def self.app_connectors_service_available? version: :v1
109
+ require "google/cloud/beyond_corp/app_connectors/#{version.to_s.downcase}"
110
+ package_name = Google::Cloud::BeyondCorp::AppConnectors
111
+ .constants
112
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
113
+ .first
114
+ return false unless package_name
115
+ service_module = Google::Cloud::BeyondCorp::AppConnectors.const_get package_name
116
+ return false unless service_module.const_defined? :AppConnectorsService
117
+ service_module = service_module.const_get :AppConnectorsService
118
+ service_module.const_defined? :Client
119
+ rescue ::LoadError
120
+ false
121
+ end
122
+
92
123
  ##
93
124
  # Configure the google-cloud-beyond_corp-app_connectors library.
94
125
  #
@@ -57,6 +57,11 @@ module Google
57
57
  # supported by that API version, and the corresponding gem is available, the
58
58
  # appropriate versioned client will be returned.
59
59
  #
60
+ # Raises an exception if the currently installed versioned client gem for the
61
+ # given API version does not support the AppGatewaysService service.
62
+ # You can determine whether the method will succeed by calling
63
+ # {Google::Cloud::BeyondCorp::AppGateways.app_gateways_service_available?}.
64
+ #
60
65
  # ## About AppGatewaysService
61
66
  #
62
67
  # API Overview:
@@ -89,6 +94,32 @@ module Google
89
94
  service_module.const_get(:Client).new(&block)
90
95
  end
91
96
 
97
+ ##
98
+ # Determines whether the AppGatewaysService service is supported by the current client.
99
+ # If true, you can retrieve a client object by calling {Google::Cloud::BeyondCorp::AppGateways.app_gateways_service}.
100
+ # If false, that method will raise an exception. This could happen if the given
101
+ # API version does not exist or does not support the AppGatewaysService service,
102
+ # or if the versioned client gem needs an update to support the AppGatewaysService service.
103
+ #
104
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
105
+ # Defaults to `:v1`.
106
+ # @return [boolean] Whether the service is available.
107
+ #
108
+ def self.app_gateways_service_available? version: :v1
109
+ require "google/cloud/beyond_corp/app_gateways/#{version.to_s.downcase}"
110
+ package_name = Google::Cloud::BeyondCorp::AppGateways
111
+ .constants
112
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
113
+ .first
114
+ return false unless package_name
115
+ service_module = Google::Cloud::BeyondCorp::AppGateways.const_get package_name
116
+ return false unless service_module.const_defined? :AppGatewaysService
117
+ service_module = service_module.const_get :AppGatewaysService
118
+ service_module.const_defined? :Client
119
+ rescue ::LoadError
120
+ false
121
+ end
122
+
92
123
  ##
93
124
  # Configure the google-cloud-beyond_corp-app_gateways library.
94
125
  #
@@ -57,6 +57,11 @@ module Google
57
57
  # supported by that API version, and the corresponding gem is available, the
58
58
  # appropriate versioned client will be returned.
59
59
  #
60
+ # Raises an exception if the currently installed versioned client gem for the
61
+ # given API version does not support the ClientGatewaysService service.
62
+ # You can determine whether the method will succeed by calling
63
+ # {Google::Cloud::BeyondCorp::ClientGateways.client_gateways_service_available?}.
64
+ #
60
65
  # ## About ClientGatewaysService
61
66
  #
62
67
  # API Overview:
@@ -86,6 +91,32 @@ module Google
86
91
  service_module.const_get(:Client).new(&block)
87
92
  end
88
93
 
94
+ ##
95
+ # Determines whether the ClientGatewaysService service is supported by the current client.
96
+ # If true, you can retrieve a client object by calling {Google::Cloud::BeyondCorp::ClientGateways.client_gateways_service}.
97
+ # If false, that method will raise an exception. This could happen if the given
98
+ # API version does not exist or does not support the ClientGatewaysService service,
99
+ # or if the versioned client gem needs an update to support the ClientGatewaysService service.
100
+ #
101
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
102
+ # Defaults to `:v1`.
103
+ # @return [boolean] Whether the service is available.
104
+ #
105
+ def self.client_gateways_service_available? version: :v1
106
+ require "google/cloud/beyond_corp/client_gateways/#{version.to_s.downcase}"
107
+ package_name = Google::Cloud::BeyondCorp::ClientGateways
108
+ .constants
109
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
110
+ .first
111
+ return false unless package_name
112
+ service_module = Google::Cloud::BeyondCorp::ClientGateways.const_get package_name
113
+ return false unless service_module.const_defined? :ClientGatewaysService
114
+ service_module = service_module.const_get :ClientGatewaysService
115
+ service_module.const_defined? :Client
116
+ rescue ::LoadError
117
+ false
118
+ end
119
+
89
120
  ##
90
121
  # Configure the google-cloud-beyond_corp-client_gateways library.
91
122
  #
@@ -17,7 +17,7 @@
17
17
  module Google
18
18
  module Cloud
19
19
  module BeyondCorp
20
- VERSION = "1.3.1"
20
+ VERSION = "1.4.1"
21
21
  end
22
22
  end
23
23
  end
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-beyond_corp
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.1
4
+ version: 1.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-06-12 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-beyond_corp-app_connections-v1
@@ -132,7 +131,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
132
131
  licenses:
133
132
  - Apache-2.0
134
133
  metadata: {}
135
- post_install_message:
136
134
  rdoc_options: []
137
135
  require_paths:
138
136
  - lib
@@ -140,15 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
140
138
  requirements:
141
139
  - - ">="
142
140
  - !ruby/object:Gem::Version
143
- version: '2.7'
141
+ version: '3.0'
144
142
  required_rubygems_version: !ruby/object:Gem::Requirement
145
143
  requirements:
146
144
  - - ">="
147
145
  - !ruby/object:Gem::Version
148
146
  version: '0'
149
147
  requirements: []
150
- rubygems_version: 3.5.6
151
- signing_key:
148
+ rubygems_version: 3.6.8
152
149
  specification_version: 4
153
150
  summary: API client library for the BeyondCorp API
154
151
  test_files: []