Skip to content

Commit f71246f

Browse files
yoshi-automationyoshi-automation
authored
docs(data_catalog-v1): Clarify that timeouts are in seconds.
1 parent 4b1d9d6 commit f71246f

25 files changed

Lines changed: 1063 additions & 1063 deletions

File tree

‎google-cloud-data_catalog-v1/AUTHENTICATION.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export DATA_CATALOG_CREDENTIALS=path/to/keyfile.json
2727
```ruby
2828
require "google/cloud/data_catalog/v1"
2929

30-
client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
30+
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
3131
```
3232

3333
## Credential Lookup
@@ -64,7 +64,7 @@ containers where writing files is difficult or not encouraged.
6464

6565
The environment variables that google-cloud-data_catalog-v1
6666
checks for credentials are configured on the service Credentials class (such as
67-
{Google::Cloud::DataCatalog::V1::DataCatalog::Credentials}):
67+
{::Google::Cloud::DataCatalog::V1::DataCatalog::Credentials}):
6868

6969
1. `DATA_CATALOG_CREDENTIALS` - Path to JSON file, or JSON contents
7070
2. `DATA_CATALOG_KEYFILE` - Path to JSON file, or JSON contents
@@ -77,7 +77,7 @@ require "google/cloud/data_catalog/v1"
7777

7878
ENV["DATA_CATALOG_CREDENTIALS"] = "path/to/keyfile.json"
7979

80-
client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
80+
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
8181
```
8282

8383
### Configuration
@@ -88,7 +88,7 @@ environment variables. Either on an individual client initialization:
8888
```ruby
8989
require "google/cloud/data_catalog/v1"
9090

91-
client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
91+
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new do |config|
9292
config.credentials = "path/to/keyfile.json"
9393
end
9494
```
@@ -98,11 +98,11 @@ Or configured globally for all clients:
9898
```ruby
9999
require "google/cloud/data_catalog/v1"
100100

101-
Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
101+
::Google::Cloud::DataCatalog::V1::DataCatalog::Client.configure do |config|
102102
config.credentials = "path/to/keyfile.json"
103103
end
104104

105-
client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
105+
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
106106
```
107107

108108
### Cloud SDK

‎google-cloud-data_catalog-v1/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ In order to use this library, you first need to go through the following steps:
2525
```ruby
2626
require "google/cloud/data_catalog/v1"
2727

28-
client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
28+
client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
2929
request = my_create_request
3030
response = client.search_catalog request
3131
```

‎google-cloud-data_catalog-v1/Rakefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ task :acceptance, :project, :keyfile do |t, args|
8585
fail "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or DATA_CATALOG_TEST_PROJECT=test123 DATA_CATALOG_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
8686
end
8787
require "google/cloud/data_catalog/v1/data_catalog/credentials"
88-
Google::Cloud::DataCatalog::V1::DataCatalog::Credentials.env_vars.each do |path|
88+
::Google::Cloud::DataCatalog::V1::DataCatalog::Credentials.env_vars.each do |path|
8989
ENV[path] = nil
9090
end
9191
ENV["DATA_CATALOG_PROJECT"] = project

‎google-cloud-data_catalog-v1/lib/google/cloud/data_catalog/v1.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module DataCatalog
2626
# To load this package, including all its services, and instantiate a client:
2727
#
2828
# require "google/cloud/data_catalog/v1"
29-
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
29+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
3030
#
3131
module V1
3232
end

‎google-cloud-data_catalog-v1/lib/google/cloud/data_catalog/v1/data_catalog.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ module V1
3737
# To load this service and instantiate a client:
3838
#
3939
# require "google/cloud/data_catalog/v1/data_catalog"
40-
# client = Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
40+
# client = ::Google::Cloud::DataCatalog::V1::DataCatalog::Client.new
4141
#
4242
module DataCatalog
4343
end

‎google-cloud-data_catalog-v1/lib/google/cloud/data_catalog/v1/data_catalog/client.rb‎

Lines changed: 514 additions & 514 deletions
Large diffs are not rendered by default.

‎google-cloud-data_catalog-v1/lib/google/cloud/data_catalog/v1/data_catalog/credentials.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module DataCatalog
2424
module V1
2525
module DataCatalog
2626
# Credentials for the DataCatalog API.
27-
class Credentials < Google::Auth::Credentials
27+
class Credentials < ::Google::Auth::Credentials
2828
self.scope = [
2929
"https://www.googleapis.com/auth/cloud-platform"
3030
]

‎google-cloud-data_catalog-v1/lib/google/cloud/data_catalog/v1/data_catalog/paths.rb‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ module Paths
3636
# @param entry_group [String]
3737
# @param entry [String]
3838
#
39-
# @return [String]
39+
# @return [::String]
4040
def entry_path project:, location:, entry_group:, entry:
41-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
42-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
43-
raise ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
41+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
42+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
43+
raise ::ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
4444

4545
"projects/#{project}/locations/#{location}/entryGroups/#{entry_group}/entries/#{entry}"
4646
end
@@ -56,10 +56,10 @@ def entry_path project:, location:, entry_group:, entry:
5656
# @param location [String]
5757
# @param entry_group [String]
5858
#
59-
# @return [String]
59+
# @return [::String]
6060
def entry_group_path project:, location:, entry_group:
61-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
62-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
61+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
62+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
6363

6464
"projects/#{project}/locations/#{location}/entryGroups/#{entry_group}"
6565
end
@@ -74,9 +74,9 @@ def entry_group_path project:, location:, entry_group:
7474
# @param project [String]
7575
# @param location [String]
7676
#
77-
# @return [String]
77+
# @return [::String]
7878
def location_path project:, location:
79-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
79+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
8080

8181
"projects/#{project}/locations/#{location}"
8282
end
@@ -94,12 +94,12 @@ def location_path project:, location:
9494
# @param entry [String]
9595
# @param tag [String]
9696
#
97-
# @return [String]
97+
# @return [::String]
9898
def tag_path project:, location:, entry_group:, entry:, tag:
99-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
100-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
101-
raise ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
102-
raise ArgumentError, "entry cannot contain /" if entry.to_s.include? "/"
99+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
100+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
101+
raise ::ArgumentError, "entry_group cannot contain /" if entry_group.to_s.include? "/"
102+
raise ::ArgumentError, "entry cannot contain /" if entry.to_s.include? "/"
103103

104104
"projects/#{project}/locations/#{location}/entryGroups/#{entry_group}/entries/#{entry}/tags/#{tag}"
105105
end
@@ -115,10 +115,10 @@ def tag_path project:, location:, entry_group:, entry:, tag:
115115
# @param location [String]
116116
# @param tag_template [String]
117117
#
118-
# @return [String]
118+
# @return [::String]
119119
def tag_template_path project:, location:, tag_template:
120-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
121-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
120+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
121+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
122122

123123
"projects/#{project}/locations/#{location}/tagTemplates/#{tag_template}"
124124
end
@@ -135,11 +135,11 @@ def tag_template_path project:, location:, tag_template:
135135
# @param tag_template [String]
136136
# @param field [String]
137137
#
138-
# @return [String]
138+
# @return [::String]
139139
def tag_template_field_path project:, location:, tag_template:, field:
140-
raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
141-
raise ArgumentError, "location cannot contain /" if location.to_s.include? "/"
142-
raise ArgumentError, "tag_template cannot contain /" if tag_template.to_s.include? "/"
140+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
141+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
142+
raise ::ArgumentError, "tag_template cannot contain /" if tag_template.to_s.include? "/"
143143

144144
"projects/#{project}/locations/#{location}/tagTemplates/#{tag_template}/fields/#{field}"
145145
end

‎google-cloud-data_catalog-v1/proto_docs/google/api/resource.rb‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ module Api
128128
# - pattern: "shelves/{shelf}"
129129
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
130130
# @!attribute [rw] type
131-
# @return [String]
131+
# @return [::String]
132132
# The resource type. It must be in the format of
133133
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134134
# singular and must not include version numbers.
@@ -140,7 +140,7 @@ module Api
140140
# should use PascalCase (UpperCamelCase). The maximum number of
141141
# characters allowed for the `resource_type_kind` is 100.
142142
# @!attribute [rw] pattern
143-
# @return [Array<String>]
143+
# @return [::Array<::String>]
144144
# Optional. The relative resource name pattern associated with this resource
145145
# type. The DNS prefix of the full resource name shouldn't be specified here.
146146
#
@@ -161,11 +161,11 @@ module Api
161161
# the same component name (e.g. "project") refers to IDs of the same
162162
# type of resource.
163163
# @!attribute [rw] name_field
164-
# @return [String]
164+
# @return [::String]
165165
# Optional. The field on the resource that designates the resource name
166166
# field. If omitted, this is assumed to be "name".
167167
# @!attribute [rw] history
168-
# @return [Google::Api::ResourceDescriptor::History]
168+
# @return [::Google::Api::ResourceDescriptor::History]
169169
# Optional. The historical or future-looking state of the resource pattern.
170170
#
171171
# Example:
@@ -182,19 +182,19 @@ module Api
182182
# };
183183
# }
184184
# @!attribute [rw] plural
185-
# @return [String]
185+
# @return [::String]
186186
# The plural name used in the resource name, such as 'projects' for
187187
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
188188
# field in k8s CRD spec
189189
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190190
# @!attribute [rw] singular
191-
# @return [String]
191+
# @return [::String]
192192
# The same concept of the `singular` field in k8s CRD spec
193193
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194194
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195195
class ResourceDescriptor
196-
include Google::Protobuf::MessageExts
197-
extend Google::Protobuf::MessageExts::ClassMethods
196+
include ::Google::Protobuf::MessageExts
197+
extend ::Google::Protobuf::MessageExts::ClassMethods
198198

199199
# A description of the historical or future-looking state of the
200200
# resource pattern.
@@ -216,7 +216,7 @@ module History
216216
# Defines a proto annotation that describes a string field that refers to
217217
# an API resource.
218218
# @!attribute [rw] type
219-
# @return [String]
219+
# @return [::String]
220220
# The resource type that the annotated field references.
221221
#
222222
# Example:
@@ -227,7 +227,7 @@ module History
227227
# }];
228228
# }
229229
# @!attribute [rw] child_type
230-
# @return [String]
230+
# @return [::String]
231231
# The resource type of a child collection that the annotated field
232232
# references. This is useful for annotating the `parent` field that
233233
# doesn't have a fixed resource type.
@@ -240,8 +240,8 @@ module History
240240
# };
241241
# }
242242
class ResourceReference
243-
include Google::Protobuf::MessageExts
244-
extend Google::Protobuf::MessageExts::ClassMethods
243+
include ::Google::Protobuf::MessageExts
244+
extend ::Google::Protobuf::MessageExts::ClassMethods
245245
end
246246
end
247247
end

0 commit comments

Comments
 (0)