google-cloud-os_login 0.2.2 → 0.2.3

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.
Files changed (16) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/os_login.rb +4 -4
  4. data/lib/google/cloud/os_login/v1.rb +4 -4
  5. data/lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/v1/oslogin.rb +6 -6
  6. data/lib/google/cloud/os_login/v1/doc/google/protobuf/empty.rb +1 -1
  7. data/lib/google/cloud/os_login/v1/doc/google/protobuf/field_mask.rb +7 -7
  8. data/lib/google/cloud/os_login/v1/os_login_service_client.rb +8 -8
  9. data/lib/google/cloud/os_login/v1beta.rb +4 -4
  10. data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/v1beta/oslogin.rb +6 -6
  11. data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/empty.rb +1 -1
  12. data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/field_mask.rb +7 -7
  13. data/lib/google/cloud/os_login/v1beta/os_login_service_client.rb +8 -8
  14. metadata +3 -5
  15. data/lib/google/cloud/os_login/v1/doc/overview.rb +0 -80
  16. data/lib/google/cloud/os_login/v1beta/doc/overview.rb +0 -80
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8f221dfa7b1d6aff9bd30622b4b1bb36f969f57304b8f10e74f9aa7588991ade
4
- data.tar.gz: 0327033cb750a156b96961591f180e06b228021f5264f065c0c7a471458f1d45
3
+ metadata.gz: e8cdae0a589d24e382da03a1995c496c1e04610a88209cb238ebff72ed5416e5
4
+ data.tar.gz: 174330914db6ad525fa26558c701b6e607173296f0abb0ede672c5440b0dda24
5
5
  SHA512:
6
- metadata.gz: 90435dfd3806856f5d06a7c4cfc0aaa05be895370d178f8d3a4401d9be962f3388fa7282ffae2c5e68823e93a233e75aeb995a2fd945912161dd10a6c6b14168
7
- data.tar.gz: 401db4bc0240d817229444df077b36f73f5e85df263b4a1833aae2171dad3a6451aff6e919e8ba0121e005d6c1ac2abb259349c3edf573befd1be3ad2fcc25fd
6
+ metadata.gz: 6314096ed8e44109c513a8b844c9cb86039992c32cc48221964af2cb2277d4fa752044610288ad12a51de7b08e641e9486a03e71c2ef73151cefec6bf35134a2
7
+ data.tar.gz: eb4319c90fa1733d6e45b67576e699788908f370fc506199a97ae184b2b8b50c605974de6a687112803953f2e1b5246d0f5ab6378f103a38387eded63ba42d44
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
1
+ # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
2
2
 
3
3
  [Google Cloud OS Login API][Product Documentation]:
4
4
  Manages OS login configuration for Google account users.
@@ -12,7 +12,7 @@ steps:
12
12
  1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
13
13
  2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
14
14
  3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
15
- 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
15
+ 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
16
16
 
17
17
  ### Installation
18
18
  ```
@@ -24,17 +24,17 @@ $ gem install google-cloud-os_login
24
24
  to see other available methods on the client.
25
25
  - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
26
26
  to learn more about the product and see How-to Guides.
27
- - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
27
+ - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
28
28
  to see the full list of Cloud APIs that we cover.
29
29
 
30
- [Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/
30
+ [Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-os_login/latest/google/cloud/oslogin/
31
31
  [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
32
32
 
33
33
  ## Enabling Logging
34
34
 
35
35
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
36
36
  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,
37
- or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
37
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
38
38
  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)
39
39
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
40
40
 
data/lib/google/cloud/os_login.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  # rubocop:disable LineLength
22
22
 
23
23
  ##
24
- # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
+ # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
25
25
  #
26
26
  # [Google Cloud OS Login API][Product Documentation]:
27
27
  # Manages OS login configuration for Google account users.
@@ -34,7 +34,7 @@ module Google
34
34
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
35
35
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
36
36
  # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
37
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
37
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
38
  #
39
39
  # ### Installation
40
40
  # ```
@@ -44,7 +44,7 @@ module Google
44
44
  # ### Next Steps
45
45
  # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
46
46
  # to learn more about the product and see How-to Guides.
47
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
47
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
48
48
  # to see the full list of Cloud APIs that we cover.
49
49
  #
50
50
  # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
@@ -53,7 +53,7 @@ module Google
53
53
  #
54
54
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
55
55
  # 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,
56
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
56
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
57
57
  # 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)
58
58
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
59
59
  #
data/lib/google/cloud/os_login/v1.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  # rubocop:disable LineLength
22
22
 
23
23
  ##
24
- # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
+ # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
25
25
  #
26
26
  # [Google Cloud OS Login API][Product Documentation]:
27
27
  # Manages OS login configuration for Google account users.
@@ -34,7 +34,7 @@ module Google
34
34
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
35
35
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
36
36
  # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
37
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
37
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
38
  #
39
39
  # ### Installation
40
40
  # ```
@@ -44,7 +44,7 @@ module Google
44
44
  # ### Next Steps
45
45
  # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
46
46
  # to learn more about the product and see How-to Guides.
47
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
47
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
48
48
  # to see the full list of Cloud APIs that we cover.
49
49
  #
50
50
  # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
@@ -53,7 +53,7 @@ module Google
53
53
  #
54
54
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
55
55
  # 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,
56
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
56
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
57
57
  # 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)
58
58
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
59
59
  #
data/lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/v1/oslogin.rb CHANGED
@@ -39,7 +39,7 @@ module Google
39
39
  # @return [String]
40
40
  # A reference to the POSIX account to update. POSIX accounts are identified
41
41
  # by the project ID they are associated with. A reference to the POSIX
42
- # account is in format +users/\\{user}/projects/\\{project}+.
42
+ # account is in format `users/{user}/projects/{project}`.
43
43
  class DeletePosixAccountRequest; end
44
44
 
45
45
  # A request message for deleting an SSH public key.
@@ -47,13 +47,13 @@ module Google
47
47
  # @return [String]
48
48
  # The fingerprint of the public key to update. Public keys are identified by
49
49
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
50
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
50
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
51
51
  class DeleteSshPublicKeyRequest; end
52
52
 
53
53
  # A request message for retrieving the login profile information for a user.
54
54
  # @!attribute [rw] name
55
55
  # @return [String]
56
- # The unique ID for the user in format +users/\\{user}+.
56
+ # The unique ID for the user in format `users/{user}`.
57
57
  class GetLoginProfileRequest; end
58
58
 
59
59
  # A request message for retrieving an SSH public key.
@@ -61,13 +61,13 @@ module Google
61
61
  # @return [String]
62
62
  # The fingerprint of the public key to retrieve. Public keys are identified
63
63
  # by their SHA-256 fingerprint. The fingerprint of the public key is in
64
- # format +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
64
+ # format `users/{user}/sshPublicKeys/{fingerprint}`.
65
65
  class GetSshPublicKeyRequest; end
66
66
 
67
67
  # A request message for importing an SSH public key.
68
68
  # @!attribute [rw] parent
69
69
  # @return [String]
70
- # The unique ID for the user in format +users/\\{user}+.
70
+ # The unique ID for the user in format `users/{user}`.
71
71
  # @!attribute [rw] ssh_public_key
72
72
  # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
73
73
  # The SSH public key and expiration time.
@@ -87,7 +87,7 @@ module Google
87
87
  # @return [String]
88
88
  # The fingerprint of the public key to update. Public keys are identified by
89
89
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
90
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
90
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
91
91
  # @!attribute [rw] ssh_public_key
92
92
  # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
93
93
  # The SSH public key and expiration time.
data/lib/google/cloud/os_login/v1/doc/google/protobuf/empty.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
24
24
  # }
25
25
  #
26
- # The JSON representation for +Empty+ is empty JSON object +{}+.
26
+ # The JSON representation for `Empty` is empty JSON object `{}`.
27
27
  class Empty; end
28
28
  end
29
29
  end
data/lib/google/cloud/os_login/v1/doc/google/protobuf/field_mask.rb CHANGED
@@ -15,14 +15,14 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +FieldMask+ represents a set of symbolic field paths, for example:
18
+ # `FieldMask` represents a set of symbolic field paths, for example:
19
19
  #
20
20
  # paths: "f.a"
21
21
  # paths: "f.b.d"
22
22
  #
23
- # Here +f+ represents a field in some root message, +a+ and +b+
24
- # fields in the message found in +f+, and +d+ a field found in the
25
- # message in +f.b+.
23
+ # Here `f` represents a field in some root message, `a` and `b`
24
+ # fields in the message found in `f`, and `d` a field found in the
25
+ # message in `f.b`.
26
26
  #
27
27
  # Field masks are used to specify a subset of fields that should be
28
28
  # returned by a get operation or modified by an update operation.
@@ -85,7 +85,7 @@ module Google
85
85
  #
86
86
  # If a repeated field is specified for an update operation, the existing
87
87
  # repeated values in the target resource will be overwritten by the new values.
88
- # Note that a repeated field is only allowed in the last position of a +paths+
88
+ # Note that a repeated field is only allowed in the last position of a `paths`
89
89
  # string.
90
90
  #
91
91
  # If a sub-message is specified in the last position of the field mask for an
@@ -177,7 +177,7 @@ module Google
177
177
  # string address = 2;
178
178
  # }
179
179
  #
180
- # In proto a field mask for +Profile+ may look as such:
180
+ # In proto a field mask for `Profile` may look as such:
181
181
  #
182
182
  # mask {
183
183
  # paths: "user.display_name"
@@ -221,7 +221,7 @@ module Google
221
221
  #
222
222
  # The implementation of any API method which has a FieldMask type field in the
223
223
  # request should verify the included field paths, and return an
224
- # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
224
+ # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
225
225
  # @!attribute [rw] paths
226
226
  # @return [Array<String>]
227
227
  # The set of field mask paths.
data/lib/google/cloud/os_login/v1/os_login_service_client.rb CHANGED
@@ -254,7 +254,7 @@ module Google
254
254
  # @param name [String]
255
255
  # A reference to the POSIX account to update. POSIX accounts are identified
256
256
  # by the project ID they are associated with. A reference to the POSIX
257
- # account is in format +users/\\{user}/projects/\\{project}+.
257
+ # account is in format `users/{user}/projects/{project}`.
258
258
  # @param options [Google::Gax::CallOptions]
259
259
  # Overrides the default settings for this call, e.g, timeout,
260
260
  # retries, etc.
@@ -286,7 +286,7 @@ module Google
286
286
  # @param name [String]
287
287
  # The fingerprint of the public key to update. Public keys are identified by
288
288
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
289
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
289
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
290
290
  # @param options [Google::Gax::CallOptions]
291
291
  # Overrides the default settings for this call, e.g, timeout,
292
292
  # retries, etc.
@@ -317,7 +317,7 @@ module Google
317
317
  # on Google Compute Engine.
318
318
  #
319
319
  # @param name [String]
320
- # The unique ID for the user in format +users/\\{user}+.
320
+ # The unique ID for the user in format `users/{user}`.
321
321
  # @param options [Google::Gax::CallOptions]
322
322
  # Overrides the default settings for this call, e.g, timeout,
323
323
  # retries, etc.
@@ -349,7 +349,7 @@ module Google
349
349
  # @param name [String]
350
350
  # The fingerprint of the public key to retrieve. Public keys are identified
351
351
  # by their SHA-256 fingerprint. The fingerprint of the public key is in
352
- # format +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
352
+ # format `users/{user}/sshPublicKeys/{fingerprint}`.
353
353
  # @param options [Google::Gax::CallOptions]
354
354
  # Overrides the default settings for this call, e.g, timeout,
355
355
  # retries, etc.
@@ -381,7 +381,7 @@ module Google
381
381
  # login profile.
382
382
  #
383
383
  # @param parent [String]
384
- # The unique ID for the user in format +users/\\{user}+.
384
+ # The unique ID for the user in format `users/{user}`.
385
385
  # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
386
386
  # The SSH public key and expiration time.
387
387
  # A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
@@ -402,7 +402,7 @@ module Google
402
402
  # os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
403
403
  # formatted_parent = Google::Cloud::OsLogin::V1::OsLoginServiceClient.user_path("[USER]")
404
404
  #
405
- # # TODO: Initialize +ssh_public_key+:
405
+ # # TODO: Initialize `ssh_public_key`:
406
406
  # ssh_public_key = {}
407
407
  # response = os_login_service_client.import_ssh_public_key(formatted_parent, ssh_public_key)
408
408
 
@@ -427,7 +427,7 @@ module Google
427
427
  # @param name [String]
428
428
  # The fingerprint of the public key to update. Public keys are identified by
429
429
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
430
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
430
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
431
431
  # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
432
432
  # The SSH public key and expiration time.
433
433
  # A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
@@ -450,7 +450,7 @@ module Google
450
450
  # os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
451
451
  # formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
452
452
  #
453
- # # TODO: Initialize +ssh_public_key+:
453
+ # # TODO: Initialize `ssh_public_key`:
454
454
  # ssh_public_key = {}
455
455
  # response = os_login_service_client.update_ssh_public_key(formatted_name, ssh_public_key)
456
456
 
data/lib/google/cloud/os_login/v1beta.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  # rubocop:disable LineLength
22
22
 
23
23
  ##
24
- # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
+ # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
25
25
  #
26
26
  # [Google Cloud OS Login API][Product Documentation]:
27
27
  # Manages OS login configuration for Google account users.
@@ -34,7 +34,7 @@ module Google
34
34
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
35
35
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
36
36
  # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
37
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
37
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
38
  #
39
39
  # ### Installation
40
40
  # ```
@@ -44,7 +44,7 @@ module Google
44
44
  # ### Next Steps
45
45
  # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
46
46
  # to learn more about the product and see How-to Guides.
47
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
47
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
48
48
  # to see the full list of Cloud APIs that we cover.
49
49
  #
50
50
  # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
@@ -53,7 +53,7 @@ module Google
53
53
  #
54
54
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
55
55
  # 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,
56
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
56
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
57
57
  # 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)
58
58
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
59
59
  #
data/lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/v1beta/oslogin.rb CHANGED
@@ -39,7 +39,7 @@ module Google
39
39
  # @return [String]
40
40
  # A reference to the POSIX account to update. POSIX accounts are identified
41
41
  # by the project ID they are associated with. A reference to the POSIX
42
- # account is in format +users/\\{user}/projects/\\{project}+.
42
+ # account is in format `users/{user}/projects/{project}`.
43
43
  class DeletePosixAccountRequest; end
44
44
 
45
45
  # A request message for deleting an SSH public key.
@@ -47,13 +47,13 @@ module Google
47
47
  # @return [String]
48
48
  # The fingerprint of the public key to update. Public keys are identified by
49
49
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
50
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
50
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
51
51
  class DeleteSshPublicKeyRequest; end
52
52
 
53
53
  # A request message for retrieving the login profile information for a user.
54
54
  # @!attribute [rw] name
55
55
  # @return [String]
56
- # The unique ID for the user in format +users/\\{user}+.
56
+ # The unique ID for the user in format `users/{user}`.
57
57
  class GetLoginProfileRequest; end
58
58
 
59
59
  # A request message for retrieving an SSH public key.
@@ -61,13 +61,13 @@ module Google
61
61
  # @return [String]
62
62
  # The fingerprint of the public key to retrieve. Public keys are identified
63
63
  # by their SHA-256 fingerprint. The fingerprint of the public key is in
64
- # format +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
64
+ # format `users/{user}/sshPublicKeys/{fingerprint}`.
65
65
  class GetSshPublicKeyRequest; end
66
66
 
67
67
  # A request message for importing an SSH public key.
68
68
  # @!attribute [rw] parent
69
69
  # @return [String]
70
- # The unique ID for the user in format +users/\\{user}+.
70
+ # The unique ID for the user in format `users/{user}`.
71
71
  # @!attribute [rw] ssh_public_key
72
72
  # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
73
73
  # The SSH public key and expiration time.
@@ -87,7 +87,7 @@ module Google
87
87
  # @return [String]
88
88
  # The fingerprint of the public key to update. Public keys are identified by
89
89
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
90
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
90
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
91
91
  # @!attribute [rw] ssh_public_key
92
92
  # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
93
93
  # The SSH public key and expiration time.
data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/empty.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
24
24
  # }
25
25
  #
26
- # The JSON representation for +Empty+ is empty JSON object +{}+.
26
+ # The JSON representation for `Empty` is empty JSON object `{}`.
27
27
  class Empty; end
28
28
  end
29
29
  end
data/lib/google/cloud/os_login/v1beta/doc/google/protobuf/field_mask.rb CHANGED
@@ -15,14 +15,14 @@
15
15
 
16
16
  module Google
17
17
  module Protobuf
18
- # +FieldMask+ represents a set of symbolic field paths, for example:
18
+ # `FieldMask` represents a set of symbolic field paths, for example:
19
19
  #
20
20
  # paths: "f.a"
21
21
  # paths: "f.b.d"
22
22
  #
23
- # Here +f+ represents a field in some root message, +a+ and +b+
24
- # fields in the message found in +f+, and +d+ a field found in the
25
- # message in +f.b+.
23
+ # Here `f` represents a field in some root message, `a` and `b`
24
+ # fields in the message found in `f`, and `d` a field found in the
25
+ # message in `f.b`.
26
26
  #
27
27
  # Field masks are used to specify a subset of fields that should be
28
28
  # returned by a get operation or modified by an update operation.
@@ -85,7 +85,7 @@ module Google
85
85
  #
86
86
  # If a repeated field is specified for an update operation, the existing
87
87
  # repeated values in the target resource will be overwritten by the new values.
88
- # Note that a repeated field is only allowed in the last position of a +paths+
88
+ # Note that a repeated field is only allowed in the last position of a `paths`
89
89
  # string.
90
90
  #
91
91
  # If a sub-message is specified in the last position of the field mask for an
@@ -177,7 +177,7 @@ module Google
177
177
  # string address = 2;
178
178
  # }
179
179
  #
180
- # In proto a field mask for +Profile+ may look as such:
180
+ # In proto a field mask for `Profile` may look as such:
181
181
  #
182
182
  # mask {
183
183
  # paths: "user.display_name"
@@ -221,7 +221,7 @@ module Google
221
221
  #
222
222
  # The implementation of any API method which has a FieldMask type field in the
223
223
  # request should verify the included field paths, and return an
224
- # +INVALID_ARGUMENT+ error if any path is duplicated or unmappable.
224
+ # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
225
225
  # @!attribute [rw] paths
226
226
  # @return [Array<String>]
227
227
  # The set of field mask paths.
data/lib/google/cloud/os_login/v1beta/os_login_service_client.rb CHANGED
@@ -254,7 +254,7 @@ module Google
254
254
  # @param name [String]
255
255
  # A reference to the POSIX account to update. POSIX accounts are identified
256
256
  # by the project ID they are associated with. A reference to the POSIX
257
- # account is in format +users/\\{user}/projects/\\{project}+.
257
+ # account is in format `users/{user}/projects/{project}`.
258
258
  # @param options [Google::Gax::CallOptions]
259
259
  # Overrides the default settings for this call, e.g, timeout,
260
260
  # retries, etc.
@@ -286,7 +286,7 @@ module Google
286
286
  # @param name [String]
287
287
  # The fingerprint of the public key to update. Public keys are identified by
288
288
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
289
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
289
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
290
290
  # @param options [Google::Gax::CallOptions]
291
291
  # Overrides the default settings for this call, e.g, timeout,
292
292
  # retries, etc.
@@ -317,7 +317,7 @@ module Google
317
317
  # on Google Compute Engine.
318
318
  #
319
319
  # @param name [String]
320
- # The unique ID for the user in format +users/\\{user}+.
320
+ # The unique ID for the user in format `users/{user}`.
321
321
  # @param options [Google::Gax::CallOptions]
322
322
  # Overrides the default settings for this call, e.g, timeout,
323
323
  # retries, etc.
@@ -349,7 +349,7 @@ module Google
349
349
  # @param name [String]
350
350
  # The fingerprint of the public key to retrieve. Public keys are identified
351
351
  # by their SHA-256 fingerprint. The fingerprint of the public key is in
352
- # format +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
352
+ # format `users/{user}/sshPublicKeys/{fingerprint}`.
353
353
  # @param options [Google::Gax::CallOptions]
354
354
  # Overrides the default settings for this call, e.g, timeout,
355
355
  # retries, etc.
@@ -381,7 +381,7 @@ module Google
381
381
  # login profile.
382
382
  #
383
383
  # @param parent [String]
384
- # The unique ID for the user in format +users/\\{user}+.
384
+ # The unique ID for the user in format `users/{user}`.
385
385
  # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
386
386
  # The SSH public key and expiration time.
387
387
  # A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
@@ -402,7 +402,7 @@ module Google
402
402
  # os_login_service_client = Google::Cloud::OsLogin::V1beta.new(version: :v1beta)
403
403
  # formatted_parent = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.user_path("[USER]")
404
404
  #
405
- # # TODO: Initialize +ssh_public_key+:
405
+ # # TODO: Initialize `ssh_public_key`:
406
406
  # ssh_public_key = {}
407
407
  # response = os_login_service_client.import_ssh_public_key(formatted_parent, ssh_public_key)
408
408
 
@@ -427,7 +427,7 @@ module Google
427
427
  # @param name [String]
428
428
  # The fingerprint of the public key to update. Public keys are identified by
429
429
  # their SHA-256 fingerprint. The fingerprint of the public key is in format
430
- # +users/\\{user}/sshPublicKeys/\\{fingerprint}+.
430
+ # `users/{user}/sshPublicKeys/{fingerprint}`.
431
431
  # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
432
432
  # The SSH public key and expiration time.
433
433
  # A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
@@ -450,7 +450,7 @@ module Google
450
450
  # os_login_service_client = Google::Cloud::OsLogin::V1beta.new(version: :v1beta)
451
451
  # formatted_name = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
452
452
  #
453
- # # TODO: Initialize +ssh_public_key+:
453
+ # # TODO: Initialize `ssh_public_key`:
454
454
  # ssh_public_key = {}
455
455
  # response = os_login_service_client.update_ssh_public_key(formatted_name, ssh_public_key)
456
456
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-os_login
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2
4
+ version: 0.2.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-09-10 00:00:00.000000000 Z
11
+ date: 2018-09-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-gax
@@ -111,7 +111,6 @@ files:
111
111
  - lib/google/cloud/os_login/v1/doc/google/cloud/oslogin/v1/oslogin.rb
112
112
  - lib/google/cloud/os_login/v1/doc/google/protobuf/empty.rb
113
113
  - lib/google/cloud/os_login/v1/doc/google/protobuf/field_mask.rb
114
- - lib/google/cloud/os_login/v1/doc/overview.rb
115
114
  - lib/google/cloud/os_login/v1/os_login_service_client.rb
116
115
  - lib/google/cloud/os_login/v1/os_login_service_client_config.json
117
116
  - lib/google/cloud/os_login/v1beta.rb
@@ -121,7 +120,6 @@ files:
121
120
  - lib/google/cloud/os_login/v1beta/doc/google/cloud/oslogin/v1beta/oslogin.rb
122
121
  - lib/google/cloud/os_login/v1beta/doc/google/protobuf/empty.rb
123
122
  - lib/google/cloud/os_login/v1beta/doc/google/protobuf/field_mask.rb
124
- - lib/google/cloud/os_login/v1beta/doc/overview.rb
125
123
  - lib/google/cloud/os_login/v1beta/os_login_service_client.rb
126
124
  - lib/google/cloud/os_login/v1beta/os_login_service_client_config.json
127
125
  - lib/google/cloud/oslogin/common/common_pb.rb
@@ -129,7 +127,7 @@ files:
129
127
  - lib/google/cloud/oslogin/v1/oslogin_services_pb.rb
130
128
  - lib/google/cloud/oslogin/v1beta/oslogin_pb.rb
131
129
  - lib/google/cloud/oslogin/v1beta/oslogin_services_pb.rb
132
- homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-os_login
130
+ homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-os_login
133
131
  licenses:
134
132
  - Apache-2.0
135
133
  metadata: {}
data/lib/google/cloud/os_login/v1/doc/overview.rb DELETED
@@ -1,80 +0,0 @@
1
- # Copyright 2018 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- # rubocop:disable LineLength
19
-
20
- ##
21
- # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
22
- #
23
- # [Google Cloud OS Login API][Product Documentation]:
24
- # Manages OS login configuration for Google account users.
25
- # - [Product Documentation][]
26
- #
27
- # ## Quick Start
28
- # In order to use this library, you first need to go through the following
29
- # steps:
30
- #
31
- # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
32
- # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
33
- # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
34
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
35
- #
36
- # ### Installation
37
- # ```
38
- # $ gem install google-cloud-os_login
39
- # ```
40
- #
41
- # ### Next Steps
42
- # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
43
- # to learn more about the product and see How-to Guides.
44
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
45
- # to see the full list of Cloud APIs that we cover.
46
- #
47
- # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
48
- #
49
- # ## Enabling Logging
50
- #
51
- # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
52
- # 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,
53
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
54
- # 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)
55
- # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
56
- #
57
- # Configuring a Ruby stdlib logger:
58
- #
59
- # ```ruby
60
- # require "logger"
61
- #
62
- # module MyLogger
63
- # LOGGER = Logger.new $stderr, level: Logger::WARN
64
- # def logger
65
- # LOGGER
66
- # end
67
- # end
68
- #
69
- # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
70
- # module GRPC
71
- # extend MyLogger
72
- # end
73
- # ```
74
- #
75
- module OsLogin
76
- module V1
77
- end
78
- end
79
- end
80
- end
data/lib/google/cloud/os_login/v1beta/doc/overview.rb DELETED
@@ -1,80 +0,0 @@
1
- # Copyright 2018 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- # rubocop:disable LineLength
19
-
20
- ##
21
- # # Ruby Client for Google Cloud OS Login API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
22
- #
23
- # [Google Cloud OS Login API][Product Documentation]:
24
- # Manages OS login configuration for Google account users.
25
- # - [Product Documentation][]
26
- #
27
- # ## Quick Start
28
- # In order to use this library, you first need to go through the following
29
- # steps:
30
- #
31
- # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
32
- # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
33
- # 3. [Enable the Google Cloud OS Login API.](https://console.cloud.google.com/apis/library/oslogin.googleapis.com)
34
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
35
- #
36
- # ### Installation
37
- # ```
38
- # $ gem install google-cloud-os_login
39
- # ```
40
- #
41
- # ### Next Steps
42
- # - Read the [Google Cloud OS Login API Product documentation][Product Documentation]
43
- # to learn more about the product and see How-to Guides.
44
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
45
- # to see the full list of Cloud APIs that we cover.
46
- #
47
- # [Product Documentation]: https://cloud.google.com/compute/docs/oslogin/rest/
48
- #
49
- # ## Enabling Logging
50
- #
51
- # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
52
- # 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,
53
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
54
- # 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)
55
- # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
56
- #
57
- # Configuring a Ruby stdlib logger:
58
- #
59
- # ```ruby
60
- # require "logger"
61
- #
62
- # module MyLogger
63
- # LOGGER = Logger.new $stderr, level: Logger::WARN
64
- # def logger
65
- # LOGGER
66
- # end
67
- # end
68
- #
69
- # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
70
- # module GRPC
71
- # extend MyLogger
72
- # end
73
- # ```
74
- #
75
- module OsLogin
76
- module V1beta
77
- end
78
- end
79
- end
80
- end