google-cloud-bigtable 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/LOGGING.md +1 -1
  4. data/OVERVIEW.md +7 -5
  5. data/lib/google-cloud-bigtable.rb +1 -1
  6. data/lib/google/cloud/bigtable/admin.rb +4 -4
  7. data/lib/google/cloud/bigtable/admin/v2.rb +4 -4
  8. data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb +66 -66
  9. data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client_config.json +16 -16
  10. data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb +42 -42
  11. data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client_config.json +8 -26
  12. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_instance_admin.rb +36 -36
  13. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb +37 -37
  14. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb +21 -21
  15. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb +26 -26
  16. data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/iam_policy.rb +13 -13
  17. data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/policy.rb +28 -28
  18. data/lib/google/cloud/bigtable/admin/v2/doc/google/longrunning/operations.rb +9 -9
  19. data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/any.rb +8 -8
  20. data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/duration.rb +3 -3
  21. data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/empty.rb +1 -1
  22. data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/field_mask.rb +7 -7
  23. data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/timestamp.rb +7 -7
  24. data/lib/google/cloud/bigtable/admin/v2/doc/google/rpc/status.rb +11 -11
  25. data/lib/google/cloud/bigtable/column_family.rb +1 -1
  26. data/lib/google/cloud/bigtable/instance.rb +11 -12
  27. data/lib/google/cloud/bigtable/project.rb +21 -21
  28. data/lib/google/cloud/bigtable/table.rb +13 -12
  29. data/lib/google/cloud/bigtable/v2.rb +4 -4
  30. data/lib/google/cloud/bigtable/v2/bigtable_client.rb +20 -20
  31. data/lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb +24 -24
  32. data/lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb +39 -39
  33. data/lib/google/cloud/bigtable/v2/doc/google/protobuf/any.rb +8 -8
  34. data/lib/google/cloud/bigtable/v2/doc/google/protobuf/wrappers.rb +18 -18
  35. data/lib/google/cloud/bigtable/v2/doc/google/rpc/status.rb +11 -11
  36. data/lib/google/cloud/bigtable/version.rb +1 -1
  37. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b030221811d66b0dbafdcfc6f545bce225c97313a17d4fb2f9f09d65d75e11dc
4
- data.tar.gz: e110bf447f449adbab5b2cac1a6c37f56c30e982e247c88980ded3f2e0b163c8
3
+ metadata.gz: 2fec9bf567174a851d94a1b7106810e58803607f39e368d76bb54eb6583e7b40
4
+ data.tar.gz: b86b5f22e24f921a46f2b8335062d129c8ec46be254063ec63e923e7cb5c1fa5
5
5
  SHA512:
6
- metadata.gz: 05a1bb9df1bedc157de97441cd2f30266fa3a602dcc741a3391517e39a9983328a3aaba4bcc85f95fa02148c258c7f810e19cfb247c20684ef3680774e523af7
7
- data.tar.gz: 06c0fbecc8faeb9ef3be4d7f87aa2f8a99eb3b2f56640c4b3596071df9568df32672e61a3d3ffb364922dd7d3eca35abcab035ff0de5c6fe0d32aeceb53fca0c
6
+ metadata.gz: a86ed842c65b0b550becf97f35ee23d725693302cec3357fe739103e5cfca937def10a0e6601d6475eb7293a4a4b56e66495029c83a3cbd328d9c8e71c46ed72
7
+ data.tar.gz: e5560028f08f23a644d8b1132628f1b568c3fb08ee81df3effd22b0c280339c27fb84979e894ce6c5a1d1c24f37c5d428b0e682615665a7460571af8151d8093
@@ -1,5 +1,11 @@
1
1
  # Release History
2
2
 
3
+ ### 0.1.3 / 2018-09-20
4
+
5
+ * Update connectivity configuration.
6
+ * Update documentation.
7
+ * Change documentation URL to googleapis GitHub org.
8
+
3
9
  ### 0.1.2 / 2018-09-12
4
10
 
5
11
  * Add missing documentation files to package.
data/LOGGING.md CHANGED
@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
5
5
  that you set may be a Ruby stdlib
6
6
  [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
7
7
  shown below, or a
8
- [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
8
+ [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
9
9
  that will write logs to [Stackdriver
10
10
  Logging](https://cloud.google.com/logging/). See
11
11
  [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
@@ -1,6 +1,6 @@
1
1
  # Cloud Bigtable
2
2
 
3
- Ruby Client for Cloud Bigtable API Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
3
+ Ruby Client for Cloud Bigtable API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
4
4
 
5
5
  [Cloud Bigtable API][Product Documentation]:
6
6
  API for reading and writing the contents of Bigtables associated with a
@@ -12,17 +12,19 @@ In order to use this library, you first need to go through the following
12
12
  steps:
13
13
 
14
14
  1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
15
- 2. [Enable billing for your oject.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_projec
16
- 3. [Enable the Cloud Bigtable API.](https://console.cloud.google.com/apis/api/bigtable)
17
- 4. [Setup thentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/mast/guides/authentication)
15
+ 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
16
+ 3. [Enable the Cloud Bigtable API.](https://console.cloud.google.com/apis/library/bigtable.googleapis.com)
17
+ 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud/latest/file.AUTHENTICATION)
18
18
 
19
19
  ### Next Steps
20
20
  - Read the [Cloud Bigtable API Product documentation][Product Documentation]
21
21
  to learn more about the product and see How-to Guides.
22
- - View this [repository's main ADME](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
22
+ - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
23
23
  to see the full list of Cloud APIs that we cover.
24
24
 
25
25
  ## Additional information
26
26
 
27
27
  Google Bigtable can be configured to use gRPC's logging. To learn more, see the
28
28
  {file:LOGGING.md Logging guide}.
29
+
30
+ [Product Documentation]: https://cloud.google.com/bigtable
@@ -21,7 +21,7 @@ gem "google-cloud-core"
21
21
 
22
22
  require "googleauth"
23
23
  require "grpc"
24
- require "google/cloud"
24
+ require "google/cloud" unless defined? Google::Cloud.new
25
25
  require "google/cloud/config"
26
26
 
27
27
  module Google
@@ -22,7 +22,7 @@ module Google
22
22
  # rubocop:disable LineLength
23
23
 
24
24
  ##
25
- # # Ruby Client for Cloud Bigtable Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
25
+ # # Ruby Client for Cloud Bigtable Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
26
26
  #
27
27
  # [Cloud Bigtable Admin API][Product Documentation]:
28
28
  #
@@ -35,7 +35,7 @@ module Google
35
35
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
36
36
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
37
37
  # 3. [Enable the Cloud Bigtable Admin API.](https://console.cloud.google.com/apis/library/bigtableadmin.googleapis.com)
38
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
38
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
39
  #
40
40
  # ### Installation
41
41
  # ```
@@ -45,7 +45,7 @@ module Google
45
45
  # ### Next Steps
46
46
  # - Read the [Cloud Bigtable Admin API Product documentation][Product Documentation]
47
47
  # to learn more about the product and see How-to Guides.
48
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
48
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
49
49
  # to see the full list of Cloud APIs that we cover.
50
50
  #
51
51
  # [Product Documentation]: https://cloud.google.com/bigtable-admin
@@ -54,7 +54,7 @@ module Google
54
54
  #
55
55
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
56
56
  # 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,
57
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
57
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
58
58
  # 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)
59
59
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
60
60
  #
@@ -25,7 +25,7 @@ module Google
25
25
  # rubocop:disable LineLength
26
26
 
27
27
  ##
28
- # # Ruby Client for Cloud Bigtable Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
28
+ # # Ruby Client for Cloud Bigtable Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
29
29
  #
30
30
  # [Cloud Bigtable Admin API][Product Documentation]:
31
31
  #
@@ -38,7 +38,7 @@ module Google
38
38
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
39
39
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
40
40
  # 3. [Enable the Cloud Bigtable Admin API.](https://console.cloud.google.com/apis/library/bigtableadmin.googleapis.com)
41
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
41
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
42
42
  #
43
43
  # ### Installation
44
44
  # ```
@@ -48,7 +48,7 @@ module Google
48
48
  # ### Next Steps
49
49
  # - Read the [Cloud Bigtable Admin API Product documentation][Product Documentation]
50
50
  # to learn more about the product and see How-to Guides.
51
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
51
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
52
52
  # to see the full list of Cloud APIs that we cover.
53
53
  #
54
54
  # [Product Documentation]: https://cloud.google.com/bigtable-admin
@@ -57,7 +57,7 @@ module Google
57
57
  #
58
58
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
59
59
  # 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,
60
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
60
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
61
61
  # 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)
62
62
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
63
63
  #
@@ -444,21 +444,21 @@ module Google
444
444
  #
445
445
  # @param parent [String]
446
446
  # The unique name of the project in which to create the new instance.
447
- # Values are of the form +projects/<project>+.
447
+ # Values are of the form `projects/<project>`.
448
448
  # @param instance_id [String]
449
449
  # The ID to be used when referring to the new instance within its project,
450
- # e.g., just +myinstance+ rather than
451
- # +projects/myproject/instances/myinstance+.
450
+ # e.g., just `myinstance` rather than
451
+ # `projects/myproject/instances/myinstance`.
452
452
  # @param instance [Google::Bigtable::Admin::V2::Instance | Hash]
453
453
  # The instance to create.
454
- # Fields marked +OutputOnly+ must be left blank.
454
+ # Fields marked `OutputOnly` must be left blank.
455
455
  # A hash of the same form as `Google::Bigtable::Admin::V2::Instance`
456
456
  # can also be provided.
457
457
  # @param clusters [Hash{String => Google::Bigtable::Admin::V2::Cluster | Hash}]
458
458
  # The clusters to be created within the instance, mapped by desired
459
- # cluster ID, e.g., just +mycluster+ rather than
460
- # +projects/myproject/instances/myinstance/clusters/mycluster+.
461
- # Fields marked +OutputOnly+ must be left blank.
459
+ # cluster ID, e.g., just `mycluster` rather than
460
+ # `projects/myproject/instances/myinstance/clusters/mycluster`.
461
+ # Fields marked `OutputOnly` must be left blank.
462
462
  # Currently, at most two clusters can be specified.
463
463
  # A hash of the same form as `Google::Bigtable::Admin::V2::Cluster`
464
464
  # can also be provided.
@@ -473,13 +473,13 @@ module Google
473
473
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
474
474
  # formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.project_path("[PROJECT]")
475
475
  #
476
- # # TODO: Initialize +instance_id+:
476
+ # # TODO: Initialize `instance_id`:
477
477
  # instance_id = ''
478
478
  #
479
- # # TODO: Initialize +instance+:
479
+ # # TODO: Initialize `instance`:
480
480
  # instance = {}
481
481
  #
482
- # # TODO: Initialize +clusters+:
482
+ # # TODO: Initialize `clusters`:
483
483
  # clusters = {}
484
484
  #
485
485
  # # Register a callback during the method call.
@@ -537,7 +537,7 @@ module Google
537
537
  #
538
538
  # @param name [String]
539
539
  # The unique name of the requested instance. Values are of the form
540
- # +projects/<project>/instances/<instance>+.
540
+ # `projects/<project>/instances/<instance>`.
541
541
  # @param options [Google::Gax::CallOptions]
542
542
  # Overrides the default settings for this call, e.g, timeout,
543
543
  # retries, etc.
@@ -568,7 +568,7 @@ module Google
568
568
  #
569
569
  # @param parent [String]
570
570
  # The unique name of the project for which a list of instances is requested.
571
- # Values are of the form +projects/<project>+.
571
+ # Values are of the form `projects/<project>`.
572
572
  # @param page_token [String]
573
573
  # DEPRECATED: This field is unused and ignored.
574
574
  # @param options [Google::Gax::CallOptions]
@@ -602,15 +602,15 @@ module Google
602
602
  # Updates an instance within a project.
603
603
  #
604
604
  # @param name [String]
605
- # (+OutputOnly+)
605
+ # (`OutputOnly`)
606
606
  # The unique name of the instance. Values are of the form
607
- # +projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]+.
607
+ # `projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
608
608
  # @param display_name [String]
609
609
  # The descriptive name for this instance as it appears in UIs.
610
610
  # Can be changed at any time, but should be kept globally unique
611
611
  # to avoid confusion.
612
612
  # @param type [Google::Bigtable::Admin::V2::Instance::Type]
613
- # The type of the instance. Defaults to +PRODUCTION+.
613
+ # The type of the instance. Defaults to `PRODUCTION`.
614
614
  # @param labels [Hash{String => String}]
615
615
  # Labels are a flexible and lightweight mechanism for organizing cloud
616
616
  # resources into groups that reflect a customer's organizational needs and
@@ -618,13 +618,13 @@ module Google
618
618
  # metrics.
619
619
  #
620
620
  # * Label keys must be between 1 and 63 characters long and must conform to
621
- # the regular expression: +[\p\\{Ll}\p\\{Lo}][\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,62}+.
621
+ # the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
622
622
  # * Label values must be between 0 and 63 characters long and must conform to
623
- # the regular expression: +[\p\\{Ll}\p\\{Lo}\p\\{N}_-]\\{0,63}+.
623
+ # the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
624
624
  # * No more than 64 labels can be associated with a given resource.
625
625
  # * Keys and values must both be under 128 bytes.
626
626
  # @param state [Google::Bigtable::Admin::V2::Instance::State]
627
- # (+OutputOnly+)
627
+ # (`OutputOnly`)
628
628
  # The current state of the instance.
629
629
  # @param options [Google::Gax::CallOptions]
630
630
  # Overrides the default settings for this call, e.g, timeout,
@@ -640,13 +640,13 @@ module Google
640
640
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
641
641
  # formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
642
642
  #
643
- # # TODO: Initialize +display_name+:
643
+ # # TODO: Initialize `display_name`:
644
644
  # display_name = ''
645
645
  #
646
- # # TODO: Initialize +type+:
646
+ # # TODO: Initialize `type`:
647
647
  # type = :TYPE_UNSPECIFIED
648
648
  #
649
- # # TODO: Initialize +labels+:
649
+ # # TODO: Initialize `labels`:
650
650
  # labels = {}
651
651
  # response = bigtable_instance_admin_client.update_instance(formatted_name, display_name, type, labels)
652
652
 
@@ -690,10 +690,10 @@ module Google
690
690
  #
691
691
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
692
692
  #
693
- # # TODO: Initialize +instance+:
693
+ # # TODO: Initialize `instance`:
694
694
  # instance = {}
695
695
  #
696
- # # TODO: Initialize +update_mask+:
696
+ # # TODO: Initialize `update_mask`:
697
697
  # update_mask = {}
698
698
  #
699
699
  # # Register a callback during the method call.
@@ -747,7 +747,7 @@ module Google
747
747
  #
748
748
  # @param name [String]
749
749
  # The unique name of the instance to be deleted.
750
- # Values are of the form +projects/<project>/instances/<instance>+.
750
+ # Values are of the form `projects/<project>/instances/<instance>`.
751
751
  # @param options [Google::Gax::CallOptions]
752
752
  # Overrides the default settings for this call, e.g, timeout,
753
753
  # retries, etc.
@@ -779,14 +779,14 @@ module Google
779
779
  # @param parent [String]
780
780
  # The unique name of the instance in which to create the new cluster.
781
781
  # Values are of the form
782
- # +projects/<project>/instances/<instance>+.
782
+ # `projects/<project>/instances/<instance>`.
783
783
  # @param cluster_id [String]
784
784
  # The ID to be used when referring to the new cluster within its instance,
785
- # e.g., just +mycluster+ rather than
786
- # +projects/myproject/instances/myinstance/clusters/mycluster+.
785
+ # e.g., just `mycluster` rather than
786
+ # `projects/myproject/instances/myinstance/clusters/mycluster`.
787
787
  # @param cluster [Google::Bigtable::Admin::V2::Cluster | Hash]
788
788
  # The cluster to be created.
789
- # Fields marked +OutputOnly+ must be left blank.
789
+ # Fields marked `OutputOnly` must be left blank.
790
790
  # A hash of the same form as `Google::Bigtable::Admin::V2::Cluster`
791
791
  # can also be provided.
792
792
  # @param options [Google::Gax::CallOptions]
@@ -800,10 +800,10 @@ module Google
800
800
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
801
801
  # formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
802
802
  #
803
- # # TODO: Initialize +cluster_id+:
803
+ # # TODO: Initialize `cluster_id`:
804
804
  # cluster_id = ''
805
805
  #
806
- # # TODO: Initialize +cluster+:
806
+ # # TODO: Initialize `cluster`:
807
807
  # cluster = {}
808
808
  #
809
809
  # # Register a callback during the method call.
@@ -859,7 +859,7 @@ module Google
859
859
  #
860
860
  # @param name [String]
861
861
  # The unique name of the requested cluster. Values are of the form
862
- # +projects/<project>/instances/<instance>/clusters/<cluster>+.
862
+ # `projects/<project>/instances/<instance>/clusters/<cluster>`.
863
863
  # @param options [Google::Gax::CallOptions]
864
864
  # Overrides the default settings for this call, e.g, timeout,
865
865
  # retries, etc.
@@ -890,9 +890,9 @@ module Google
890
890
  #
891
891
  # @param parent [String]
892
892
  # The unique name of the instance for which a list of clusters is requested.
893
- # Values are of the form +projects/<project>/instances/<instance>+.
894
- # Use +<instance> = '-'+ to list Clusters for all Instances in a project,
895
- # e.g., +projects/myproject/instances/-+.
893
+ # Values are of the form `projects/<project>/instances/<instance>`.
894
+ # Use `<instance> = '-'` to list Clusters for all Instances in a project,
895
+ # e.g., `projects/myproject/instances/-`.
896
896
  # @param page_token [String]
897
897
  # DEPRECATED: This field is unused and ignored.
898
898
  # @param options [Google::Gax::CallOptions]
@@ -926,23 +926,23 @@ module Google
926
926
  # Updates a cluster within an instance.
927
927
  #
928
928
  # @param name [String]
929
- # (+OutputOnly+)
929
+ # (`OutputOnly`)
930
930
  # The unique name of the cluster. Values are of the form
931
- # +projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*+.
931
+ # `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`.
932
932
  # @param serve_nodes [Integer]
933
933
  # The number of nodes allocated to this cluster. More nodes enable higher
934
934
  # throughput and more consistent performance.
935
935
  # @param location [String]
936
- # (+CreationOnly+)
936
+ # (`CreationOnly`)
937
937
  # The location where this cluster's nodes and storage reside. For best
938
938
  # performance, clients should be located as close as possible to this
939
939
  # cluster. Currently only zones are supported, so values should be of the
940
- # form +projects/<project>/locations/<zone>+.
940
+ # form `projects/<project>/locations/<zone>`.
941
941
  # @param state [Google::Bigtable::Admin::V2::Cluster::State]
942
- # (+OutputOnly+)
942
+ # (`OutputOnly`)
943
943
  # The current state of the cluster.
944
944
  # @param default_storage_type [Google::Bigtable::Admin::V2::StorageType]
945
- # (+CreationOnly+)
945
+ # (`CreationOnly`)
946
946
  # The type of storage used by this cluster to serve its
947
947
  # parent instance's tables, unless explicitly overridden.
948
948
  # @param options [Google::Gax::CallOptions]
@@ -956,7 +956,7 @@ module Google
956
956
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
957
957
  # formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.cluster_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]")
958
958
  #
959
- # # TODO: Initialize +serve_nodes+:
959
+ # # TODO: Initialize `serve_nodes`:
960
960
  # serve_nodes = 0
961
961
  #
962
962
  # # Register a callback during the method call.
@@ -1016,7 +1016,7 @@ module Google
1016
1016
  #
1017
1017
  # @param name [String]
1018
1018
  # The unique name of the cluster to be deleted. Values are of the form
1019
- # +projects/<project>/instances/<instance>/clusters/<cluster>+.
1019
+ # `projects/<project>/instances/<instance>/clusters/<cluster>`.
1020
1020
  # @param options [Google::Gax::CallOptions]
1021
1021
  # Overrides the default settings for this call, e.g, timeout,
1022
1022
  # retries, etc.
@@ -1048,14 +1048,14 @@ module Google
1048
1048
  # @param parent [String]
1049
1049
  # The unique name of the instance in which to create the new app profile.
1050
1050
  # Values are of the form
1051
- # +projects/<project>/instances/<instance>+.
1051
+ # `projects/<project>/instances/<instance>`.
1052
1052
  # @param app_profile_id [String]
1053
1053
  # The ID to be used when referring to the new app profile within its
1054
- # instance, e.g., just +myprofile+ rather than
1055
- # +projects/myproject/instances/myinstance/appProfiles/myprofile+.
1054
+ # instance, e.g., just `myprofile` rather than
1055
+ # `projects/myproject/instances/myinstance/appProfiles/myprofile`.
1056
1056
  # @param app_profile [Google::Bigtable::Admin::V2::AppProfile | Hash]
1057
1057
  # The app profile to be created.
1058
- # Fields marked +OutputOnly+ will be ignored.
1058
+ # Fields marked `OutputOnly` will be ignored.
1059
1059
  # A hash of the same form as `Google::Bigtable::Admin::V2::AppProfile`
1060
1060
  # can also be provided.
1061
1061
  # @param ignore_warnings [true, false]
@@ -1074,10 +1074,10 @@ module Google
1074
1074
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
1075
1075
  # formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
1076
1076
  #
1077
- # # TODO: Initialize +app_profile_id+:
1077
+ # # TODO: Initialize `app_profile_id`:
1078
1078
  # app_profile_id = ''
1079
1079
  #
1080
- # # TODO: Initialize +app_profile+:
1080
+ # # TODO: Initialize `app_profile`:
1081
1081
  # app_profile = {}
1082
1082
  # response = bigtable_instance_admin_client.create_app_profile(formatted_parent, app_profile_id, app_profile)
1083
1083
 
@@ -1102,7 +1102,7 @@ module Google
1102
1102
  #
1103
1103
  # @param name [String]
1104
1104
  # The unique name of the requested app profile. Values are of the form
1105
- # +projects/<project>/instances/<instance>/appProfiles/<app_profile>+.
1105
+ # `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
1106
1106
  # @param options [Google::Gax::CallOptions]
1107
1107
  # Overrides the default settings for this call, e.g, timeout,
1108
1108
  # retries, etc.
@@ -1134,9 +1134,9 @@ module Google
1134
1134
  # @param parent [String]
1135
1135
  # The unique name of the instance for which a list of app profiles is
1136
1136
  # requested. Values are of the form
1137
- # +projects/<project>/instances/<instance>+.
1138
- # Use +<instance> = '-'+ to list AppProfiles for all Instances in a project,
1139
- # e.g., +projects/myproject/instances/-+.
1137
+ # `projects/<project>/instances/<instance>`.
1138
+ # Use `<instance> = '-'` to list AppProfiles for all Instances in a project,
1139
+ # e.g., `projects/myproject/instances/-`.
1140
1140
  # @param page_size [Integer]
1141
1141
  # Maximum number of results per page.
1142
1142
  # CURRENTLY UNIMPLEMENTED AND IGNORED.
@@ -1207,10 +1207,10 @@ module Google
1207
1207
  #
1208
1208
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
1209
1209
  #
1210
- # # TODO: Initialize +app_profile+:
1210
+ # # TODO: Initialize `app_profile`:
1211
1211
  # app_profile = {}
1212
1212
  #
1213
- # # TODO: Initialize +update_mask+:
1213
+ # # TODO: Initialize `update_mask`:
1214
1214
  # update_mask = {}
1215
1215
  #
1216
1216
  # # Register a callback during the method call.
@@ -1266,7 +1266,7 @@ module Google
1266
1266
  #
1267
1267
  # @param name [String]
1268
1268
  # The unique name of the app profile to be deleted. Values are of the form
1269
- # +projects/<project>/instances/<instance>/appProfiles/<app_profile>+.
1269
+ # `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
1270
1270
  # @param ignore_warnings [true, false]
1271
1271
  # If true, ignore safety checks when deleting the app profile.
1272
1272
  # @param options [Google::Gax::CallOptions]
@@ -1282,7 +1282,7 @@ module Google
1282
1282
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
1283
1283
  # formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.app_profile_path("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]")
1284
1284
  #
1285
- # # TODO: Initialize +ignore_warnings+:
1285
+ # # TODO: Initialize `ignore_warnings`:
1286
1286
  # ignore_warnings = false
1287
1287
  # bigtable_instance_admin_client.delete_app_profile(formatted_name, ignore_warnings)
1288
1288
 
@@ -1305,8 +1305,8 @@ module Google
1305
1305
  #
1306
1306
  # @param resource [String]
1307
1307
  # REQUIRED: The resource for which the policy is being requested.
1308
- # +resource+ is usually specified as a path. For example, a Project
1309
- # resource is specified as +projects/\\{project}+.
1308
+ # `resource` is usually specified as a path. For example, a Project
1309
+ # resource is specified as `projects/{project}`.
1310
1310
  # @param options [Google::Gax::CallOptions]
1311
1311
  # Overrides the default settings for this call, e.g, timeout,
1312
1312
  # retries, etc.
@@ -1338,10 +1338,10 @@ module Google
1338
1338
  #
1339
1339
  # @param resource [String]
1340
1340
  # REQUIRED: The resource for which the policy is being specified.
1341
- # +resource+ is usually specified as a path. For example, a Project
1342
- # resource is specified as +projects/\\{project}+.
1341
+ # `resource` is usually specified as a path. For example, a Project
1342
+ # resource is specified as `projects/{project}`.
1343
1343
  # @param policy [Google::Iam::V1::Policy | Hash]
1344
- # REQUIRED: The complete policy to be applied to the +resource+. The size of
1344
+ # REQUIRED: The complete policy to be applied to the `resource`. The size of
1345
1345
  # the policy is limited to a few 10s of KB. An empty policy is a
1346
1346
  # valid policy but certain Cloud Platform services (such as Projects)
1347
1347
  # might reject them.
@@ -1361,7 +1361,7 @@ module Google
1361
1361
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
1362
1362
  # formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
1363
1363
  #
1364
- # # TODO: Initialize +policy+:
1364
+ # # TODO: Initialize `policy`:
1365
1365
  # policy = {}
1366
1366
  # response = bigtable_instance_admin_client.set_iam_policy(formatted_resource, policy)
1367
1367
 
@@ -1382,10 +1382,10 @@ module Google
1382
1382
  #
1383
1383
  # @param resource [String]
1384
1384
  # REQUIRED: The resource for which the policy detail is being requested.
1385
- # +resource+ is usually specified as a path. For example, a Project
1386
- # resource is specified as +projects/\\{project}+.
1385
+ # `resource` is usually specified as a path. For example, a Project
1386
+ # resource is specified as `projects/{project}`.
1387
1387
  # @param permissions [Array<String>]
1388
- # The set of permissions to check for the +resource+. Permissions with
1388
+ # The set of permissions to check for the `resource`. Permissions with
1389
1389
  # wildcards (such as '*' or 'storage.*') are not allowed. For more
1390
1390
  # information see
1391
1391
  # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
@@ -1403,7 +1403,7 @@ module Google
1403
1403
  # bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
1404
1404
  # formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
1405
1405
  #
1406
- # # TODO: Initialize +permissions+:
1406
+ # # TODO: Initialize `permissions`:
1407
1407
  # permissions = []
1408
1408
  # response = bigtable_instance_admin_client.test_iam_permissions(formatted_resource, permissions)
1409
1409