google-cloud-storage_insights-v1 0.2.2 → 0.4.0
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 +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/storage_insights/v1/storage_insights/client.rb +42 -9
- data/lib/google/cloud/storage_insights/v1/storage_insights/rest/client.rb +154 -7
- data/lib/google/cloud/storage_insights/v1/storage_insights/rest/service_stub.rb +14 -2
- data/lib/google/cloud/storage_insights/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 20affb123b1d71953eaa0e24723068d611644770d38c7bd7938318bd02459708
|
4
|
+
data.tar.gz: 3dca0eae86d90f4ac7a7eed44be2e5cfaa2d2c175247474c3cf6c43507c05403
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3072fa9c53a0c46b637a23bb8dcd2abcc3c56f0d23bb5ab3989ac3fd924244f9e78ce2bc021f2ad5d18181d1e96621099ffa1b138842b2c815e26ab9b0f39d4d
|
7
|
+
data.tar.gz: 6e09ef2f3b6c3522850b1b30fd0f04716ec35d3633b519a2e0f13b17b242373516bc7ac7ef894736baa4ff354cbb990456971724e1c66376c000aacdfe3b30b6
|
data/AUTHENTICATION.md
CHANGED
@@ -1,149 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-cloud-storage_insights-v1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-storage_insights-v1 library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-cloud-storage_insights-v1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Cloud::StorageInsights::V1::StorageInsights::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
72
41
|
|
73
|
-
|
74
|
-
require "google/cloud/storage_insights/v1"
|
75
|
-
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
77
43
|
|
78
|
-
client
|
79
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
80
49
|
|
81
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
82
53
|
|
83
|
-
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
85
55
|
|
86
56
|
```ruby
|
87
57
|
require "google/cloud/storage_insights/v1"
|
88
58
|
|
89
59
|
client = ::Google::Cloud::StorageInsights::V1::StorageInsights::Client.new do |config|
|
90
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
91
61
|
end
|
92
62
|
```
|
93
63
|
|
94
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
95
65
|
|
96
66
|
```ruby
|
97
67
|
require "google/cloud/storage_insights/v1"
|
98
68
|
|
99
69
|
::Google::Cloud::StorageInsights::V1::StorageInsights::Client.configure do |config|
|
100
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
101
71
|
end
|
102
72
|
|
103
73
|
client = ::Google::Cloud::StorageInsights::V1::StorageInsights::Client.new
|
104
74
|
```
|
105
75
|
|
106
|
-
###
|
76
|
+
### Environment Variables
|
107
77
|
|
108
|
-
|
109
|
-
|
110
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
111
82
|
|
112
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
113
87
|
|
114
|
-
|
115
|
-
|
116
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-cloud-storage_insights-v1
|
93
|
+
checks for credentials are:
|
117
94
|
|
118
|
-
|
119
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
120
97
|
|
121
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/storage_insights/v1"
|
122
100
|
|
123
|
-
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
125
|
-
connect to most services with google-cloud-storage_insights-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
126
102
|
|
127
|
-
|
128
|
-
|
129
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::StorageInsights::V1::StorageInsights::Client.new
|
104
|
+
```
|
130
105
|
|
131
|
-
|
132
|
-
2. Create a new project or click on an existing project.
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
134
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
135
107
|
|
136
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
137
111
|
|
138
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
139
113
|
|
140
|
-
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
142
115
|
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
147
120
|
|
148
|
-
|
149
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -31,6 +31,9 @@ module Google
|
|
31
31
|
# Service describing handlers for resources
|
32
32
|
#
|
33
33
|
class Client
|
34
|
+
# @private
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "storageinsights.$UNIVERSE_DOMAIN$"
|
36
|
+
|
34
37
|
include Paths
|
35
38
|
|
36
39
|
# @private
|
@@ -113,6 +116,15 @@ module Google
|
|
113
116
|
@config
|
114
117
|
end
|
115
118
|
|
119
|
+
##
|
120
|
+
# The effective universe domain
|
121
|
+
#
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
def universe_domain
|
125
|
+
@storage_insights_stub.universe_domain
|
126
|
+
end
|
127
|
+
|
116
128
|
##
|
117
129
|
# Create a new StorageInsights client object.
|
118
130
|
#
|
@@ -146,8 +158,9 @@ module Google
|
|
146
158
|
credentials = @config.credentials
|
147
159
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
148
160
|
# but only if the default endpoint does not have a region prefix.
|
149
|
-
enable_self_signed_jwt = @config.endpoint
|
150
|
-
|
161
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
162
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
163
|
+
!@config.endpoint.split(".").first.include?("-"))
|
151
164
|
credentials ||= Credentials.default scope: @config.scope,
|
152
165
|
enable_self_signed_jwt: enable_self_signed_jwt
|
153
166
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -160,14 +173,18 @@ module Google
|
|
160
173
|
config.credentials = credentials
|
161
174
|
config.quota_project = @quota_project_id
|
162
175
|
config.endpoint = @config.endpoint
|
176
|
+
config.universe_domain = @config.universe_domain
|
163
177
|
end
|
164
178
|
|
165
179
|
@storage_insights_stub = ::Gapic::ServiceStub.new(
|
166
180
|
::Google::Cloud::StorageInsights::V1::StorageInsights::Stub,
|
167
|
-
credentials:
|
168
|
-
endpoint:
|
181
|
+
credentials: credentials,
|
182
|
+
endpoint: @config.endpoint,
|
183
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
184
|
+
universe_domain: @config.universe_domain,
|
169
185
|
channel_args: @config.channel_args,
|
170
|
-
interceptors: @config.interceptors
|
186
|
+
interceptors: @config.interceptors,
|
187
|
+
channel_pool_config: @config.channel_pool
|
171
188
|
)
|
172
189
|
end
|
173
190
|
|
@@ -885,9 +902,9 @@ module Google
|
|
885
902
|
# end
|
886
903
|
#
|
887
904
|
# @!attribute [rw] endpoint
|
888
|
-
#
|
889
|
-
#
|
890
|
-
# @return [::String]
|
905
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
906
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
907
|
+
# @return [::String,nil]
|
891
908
|
# @!attribute [rw] credentials
|
892
909
|
# Credentials to send with calls. You may provide any of the following types:
|
893
910
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -933,13 +950,20 @@ module Google
|
|
933
950
|
# @!attribute [rw] quota_project
|
934
951
|
# A separate project against which to charge quota.
|
935
952
|
# @return [::String]
|
953
|
+
# @!attribute [rw] universe_domain
|
954
|
+
# The universe domain within which to make requests. This determines the
|
955
|
+
# default endpoint URL. The default value of nil uses the environment
|
956
|
+
# universe (usually the default "googleapis.com" universe).
|
957
|
+
# @return [::String,nil]
|
936
958
|
#
|
937
959
|
class Configuration
|
938
960
|
extend ::Gapic::Config
|
939
961
|
|
962
|
+
# @private
|
963
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
940
964
|
DEFAULT_ENDPOINT = "storageinsights.googleapis.com"
|
941
965
|
|
942
|
-
config_attr :endpoint,
|
966
|
+
config_attr :endpoint, nil, ::String, nil
|
943
967
|
config_attr :credentials, nil do |value|
|
944
968
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
945
969
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -954,6 +978,7 @@ module Google
|
|
954
978
|
config_attr :metadata, nil, ::Hash, nil
|
955
979
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
956
980
|
config_attr :quota_project, nil, ::String, nil
|
981
|
+
config_attr :universe_domain, nil, ::String, nil
|
957
982
|
|
958
983
|
# @private
|
959
984
|
def initialize parent_config = nil
|
@@ -974,6 +999,14 @@ module Google
|
|
974
999
|
end
|
975
1000
|
end
|
976
1001
|
|
1002
|
+
##
|
1003
|
+
# Configuration for the channel pool
|
1004
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1005
|
+
#
|
1006
|
+
def channel_pool
|
1007
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1008
|
+
end
|
1009
|
+
|
977
1010
|
##
|
978
1011
|
# Configuration RPC class for the StorageInsights API.
|
979
1012
|
#
|
@@ -33,6 +33,9 @@ module Google
|
|
33
33
|
# Service describing handlers for resources
|
34
34
|
#
|
35
35
|
class Client
|
36
|
+
# @private
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "storageinsights.$UNIVERSE_DOMAIN$"
|
38
|
+
|
36
39
|
include Paths
|
37
40
|
|
38
41
|
# @private
|
@@ -115,6 +118,15 @@ module Google
|
|
115
118
|
@config
|
116
119
|
end
|
117
120
|
|
121
|
+
##
|
122
|
+
# The effective universe domain
|
123
|
+
#
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
def universe_domain
|
127
|
+
@storage_insights_stub.universe_domain
|
128
|
+
end
|
129
|
+
|
118
130
|
##
|
119
131
|
# Create a new StorageInsights REST client object.
|
120
132
|
#
|
@@ -142,8 +154,9 @@ module Google
|
|
142
154
|
credentials = @config.credentials
|
143
155
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
144
156
|
# but only if the default endpoint does not have a region prefix.
|
145
|
-
enable_self_signed_jwt = @config.endpoint
|
146
|
-
|
157
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
158
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
159
|
+
!@config.endpoint.split(".").first.include?("-"))
|
147
160
|
credentials ||= Credentials.default scope: @config.scope,
|
148
161
|
enable_self_signed_jwt: enable_self_signed_jwt
|
149
162
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -157,10 +170,16 @@ module Google
|
|
157
170
|
config.credentials = credentials
|
158
171
|
config.quota_project = @quota_project_id
|
159
172
|
config.endpoint = @config.endpoint
|
173
|
+
config.universe_domain = @config.universe_domain
|
160
174
|
config.bindings_override = @config.bindings_override
|
161
175
|
end
|
162
176
|
|
163
|
-
@storage_insights_stub = ::Google::Cloud::StorageInsights::V1::StorageInsights::Rest::ServiceStub.new
|
177
|
+
@storage_insights_stub = ::Google::Cloud::StorageInsights::V1::StorageInsights::Rest::ServiceStub.new(
|
178
|
+
endpoint: @config.endpoint,
|
179
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
180
|
+
universe_domain: @config.universe_domain,
|
181
|
+
credentials: credentials
|
182
|
+
)
|
164
183
|
end
|
165
184
|
|
166
185
|
##
|
@@ -208,6 +227,26 @@ module Google
|
|
208
227
|
# @return [::Google::Cloud::StorageInsights::V1::ListReportConfigsResponse]
|
209
228
|
#
|
210
229
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
230
|
+
#
|
231
|
+
# @example Basic example
|
232
|
+
# require "google/cloud/storage_insights/v1"
|
233
|
+
#
|
234
|
+
# # Create a client object. The client can be reused for multiple calls.
|
235
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
236
|
+
#
|
237
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
238
|
+
# request = Google::Cloud::StorageInsights::V1::ListReportConfigsRequest.new
|
239
|
+
#
|
240
|
+
# # Call the list_report_configs method.
|
241
|
+
# result = client.list_report_configs request
|
242
|
+
#
|
243
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
244
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
245
|
+
# result.each do |item|
|
246
|
+
# # Each element is of type ::Google::Cloud::StorageInsights::V1::ReportConfig.
|
247
|
+
# p item
|
248
|
+
# end
|
249
|
+
#
|
211
250
|
def list_report_configs request, options = nil
|
212
251
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
213
252
|
|
@@ -270,6 +309,22 @@ module Google
|
|
270
309
|
# @return [::Google::Cloud::StorageInsights::V1::ReportConfig]
|
271
310
|
#
|
272
311
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
312
|
+
#
|
313
|
+
# @example Basic example
|
314
|
+
# require "google/cloud/storage_insights/v1"
|
315
|
+
#
|
316
|
+
# # Create a client object. The client can be reused for multiple calls.
|
317
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
318
|
+
#
|
319
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
320
|
+
# request = Google::Cloud::StorageInsights::V1::GetReportConfigRequest.new
|
321
|
+
#
|
322
|
+
# # Call the get_report_config method.
|
323
|
+
# result = client.get_report_config request
|
324
|
+
#
|
325
|
+
# # The returned object is of type Google::Cloud::StorageInsights::V1::ReportConfig.
|
326
|
+
# p result
|
327
|
+
#
|
273
328
|
def get_report_config request, options = nil
|
274
329
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
275
330
|
|
@@ -348,6 +403,22 @@ module Google
|
|
348
403
|
# @return [::Google::Cloud::StorageInsights::V1::ReportConfig]
|
349
404
|
#
|
350
405
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
406
|
+
#
|
407
|
+
# @example Basic example
|
408
|
+
# require "google/cloud/storage_insights/v1"
|
409
|
+
#
|
410
|
+
# # Create a client object. The client can be reused for multiple calls.
|
411
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
412
|
+
#
|
413
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
414
|
+
# request = Google::Cloud::StorageInsights::V1::CreateReportConfigRequest.new
|
415
|
+
#
|
416
|
+
# # Call the create_report_config method.
|
417
|
+
# result = client.create_report_config request
|
418
|
+
#
|
419
|
+
# # The returned object is of type Google::Cloud::StorageInsights::V1::ReportConfig.
|
420
|
+
# p result
|
421
|
+
#
|
351
422
|
def create_report_config request, options = nil
|
352
423
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
353
424
|
|
@@ -430,6 +501,22 @@ module Google
|
|
430
501
|
# @return [::Google::Cloud::StorageInsights::V1::ReportConfig]
|
431
502
|
#
|
432
503
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
504
|
+
#
|
505
|
+
# @example Basic example
|
506
|
+
# require "google/cloud/storage_insights/v1"
|
507
|
+
#
|
508
|
+
# # Create a client object. The client can be reused for multiple calls.
|
509
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
510
|
+
#
|
511
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
512
|
+
# request = Google::Cloud::StorageInsights::V1::UpdateReportConfigRequest.new
|
513
|
+
#
|
514
|
+
# # Call the update_report_config method.
|
515
|
+
# result = client.update_report_config request
|
516
|
+
#
|
517
|
+
# # The returned object is of type Google::Cloud::StorageInsights::V1::ReportConfig.
|
518
|
+
# p result
|
519
|
+
#
|
433
520
|
def update_report_config request, options = nil
|
434
521
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
435
522
|
|
@@ -508,6 +595,22 @@ module Google
|
|
508
595
|
# @return [::Google::Protobuf::Empty]
|
509
596
|
#
|
510
597
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
598
|
+
#
|
599
|
+
# @example Basic example
|
600
|
+
# require "google/cloud/storage_insights/v1"
|
601
|
+
#
|
602
|
+
# # Create a client object. The client can be reused for multiple calls.
|
603
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
604
|
+
#
|
605
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
606
|
+
# request = Google::Cloud::StorageInsights::V1::DeleteReportConfigRequest.new
|
607
|
+
#
|
608
|
+
# # Call the delete_report_config method.
|
609
|
+
# result = client.delete_report_config request
|
610
|
+
#
|
611
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
612
|
+
# p result
|
613
|
+
#
|
511
614
|
def delete_report_config request, options = nil
|
512
615
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
513
616
|
|
@@ -579,6 +682,26 @@ module Google
|
|
579
682
|
# @return [::Google::Cloud::StorageInsights::V1::ListReportDetailsResponse]
|
580
683
|
#
|
581
684
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
685
|
+
#
|
686
|
+
# @example Basic example
|
687
|
+
# require "google/cloud/storage_insights/v1"
|
688
|
+
#
|
689
|
+
# # Create a client object. The client can be reused for multiple calls.
|
690
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
691
|
+
#
|
692
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
693
|
+
# request = Google::Cloud::StorageInsights::V1::ListReportDetailsRequest.new
|
694
|
+
#
|
695
|
+
# # Call the list_report_details method.
|
696
|
+
# result = client.list_report_details request
|
697
|
+
#
|
698
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
699
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
700
|
+
# result.each do |item|
|
701
|
+
# # Each element is of type ::Google::Cloud::StorageInsights::V1::ReportDetail.
|
702
|
+
# p item
|
703
|
+
# end
|
704
|
+
#
|
582
705
|
def list_report_details request, options = nil
|
583
706
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
584
707
|
|
@@ -641,6 +764,22 @@ module Google
|
|
641
764
|
# @return [::Google::Cloud::StorageInsights::V1::ReportDetail]
|
642
765
|
#
|
643
766
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
767
|
+
#
|
768
|
+
# @example Basic example
|
769
|
+
# require "google/cloud/storage_insights/v1"
|
770
|
+
#
|
771
|
+
# # Create a client object. The client can be reused for multiple calls.
|
772
|
+
# client = Google::Cloud::StorageInsights::V1::StorageInsights::Rest::Client.new
|
773
|
+
#
|
774
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
775
|
+
# request = Google::Cloud::StorageInsights::V1::GetReportDetailRequest.new
|
776
|
+
#
|
777
|
+
# # Call the get_report_detail method.
|
778
|
+
# result = client.get_report_detail request
|
779
|
+
#
|
780
|
+
# # The returned object is of type Google::Cloud::StorageInsights::V1::ReportDetail.
|
781
|
+
# p result
|
782
|
+
#
|
644
783
|
def get_report_detail request, options = nil
|
645
784
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
646
785
|
|
@@ -706,9 +845,9 @@ module Google
|
|
706
845
|
# end
|
707
846
|
#
|
708
847
|
# @!attribute [rw] endpoint
|
709
|
-
#
|
710
|
-
#
|
711
|
-
# @return [::String]
|
848
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
849
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
850
|
+
# @return [::String,nil]
|
712
851
|
# @!attribute [rw] credentials
|
713
852
|
# Credentials to send with calls. You may provide any of the following types:
|
714
853
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -745,13 +884,20 @@ module Google
|
|
745
884
|
# @!attribute [rw] quota_project
|
746
885
|
# A separate project against which to charge quota.
|
747
886
|
# @return [::String]
|
887
|
+
# @!attribute [rw] universe_domain
|
888
|
+
# The universe domain within which to make requests. This determines the
|
889
|
+
# default endpoint URL. The default value of nil uses the environment
|
890
|
+
# universe (usually the default "googleapis.com" universe).
|
891
|
+
# @return [::String,nil]
|
748
892
|
#
|
749
893
|
class Configuration
|
750
894
|
extend ::Gapic::Config
|
751
895
|
|
896
|
+
# @private
|
897
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
752
898
|
DEFAULT_ENDPOINT = "storageinsights.googleapis.com"
|
753
899
|
|
754
|
-
config_attr :endpoint,
|
900
|
+
config_attr :endpoint, nil, ::String, nil
|
755
901
|
config_attr :credentials, nil do |value|
|
756
902
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
757
903
|
allowed.any? { |klass| klass === value }
|
@@ -763,6 +909,7 @@ module Google
|
|
763
909
|
config_attr :metadata, nil, ::Hash, nil
|
764
910
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
765
911
|
config_attr :quota_project, nil, ::String, nil
|
912
|
+
config_attr :universe_domain, nil, ::String, nil
|
766
913
|
|
767
914
|
# @private
|
768
915
|
# Overrides for http bindings for the RPCs of this service
|
@@ -30,16 +30,28 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
43
55
|
##
|
44
56
|
# Baseline implementation for the list_report_configs REST call
|
45
57
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-storage_insights-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,7 +50,7 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - ">="
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: '0.
|
53
|
+
version: '0.7'
|
54
54
|
- - "<"
|
55
55
|
- !ruby/object:Gem::Version
|
56
56
|
version: 2.a
|
@@ -60,7 +60,7 @@ dependencies:
|
|
60
60
|
requirements:
|
61
61
|
- - ">="
|
62
62
|
- !ruby/object:Gem::Version
|
63
|
-
version: '0.
|
63
|
+
version: '0.7'
|
64
64
|
- - "<"
|
65
65
|
- !ruby/object:Gem::Version
|
66
66
|
version: 2.a
|
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
236
236
|
- !ruby/object:Gem::Version
|
237
237
|
version: '0'
|
238
238
|
requirements: []
|
239
|
-
rubygems_version: 3.
|
239
|
+
rubygems_version: 3.5.3
|
240
240
|
signing_key:
|
241
241
|
specification_version: 4
|
242
242
|
summary: Provides insights capability on Google Cloud Storage.
|