Skip to content

Commit dedd71f

Browse files
docs: update SelectiveGapicGeneration usage doc (#33478)
* docs: update SelectiveGapicGeneration usage doc PiperOrigin-RevId: 892649773 Source-Link: googleapis/googleapis@06a20b2 Source-Link: googleapis/googleapis-gen@d9ae664 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWVzc2VudGlhbF9jb250YWN0cy12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWV2ZW50YXJjLXB1Ymxpc2hpbmctdjEvLk93bEJvdC55YW1sIiwiaCI6ImQ5YWU2NjQ1MWY4MWM5ZGY5OWRiZGM5YjIzYmQ3NWQwMDczODBmNGUifQ== Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWV2ZW50YXJjLXYxLy5Pd2xCb3QueWFtbCIsImgiOiJkOWFlNjY0NTFmODFjOWRmOTlkYmRjOWIyM2JkNzVkMDA3MzgwZjRlIn0= Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWZpbGVzdG9yZS12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWZpbmFuY2lhbF9zZXJ2aWNlcy12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWZpcmVzdG9yZS1hZG1pbi12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy12Mi8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdkY19oYXJkd2FyZV9tYW5hZ2VtZW50LXYxYWxwaGEvLk93bEJvdC55YW1sIiwiaCI6ImQ5YWU2NjQ1MWY4MWM5ZGY5OWRiZGM5YjIzYmQ3NWQwMDczODBmNGUifQ== Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdlbWluaV9kYXRhX2FuYWx5dGljcy12MWJldGEvLk93bEJvdC55YW1sIiwiaCI6ImQ5YWU2NjQ1MWY4MWM5ZGY5OWRiZGM5YjIzYmQ3NWQwMDczODBmNGUifQ== Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdrZV9iYWNrdXAtdjEvLk93bEJvdC55YW1sIiwiaCI6ImQ5YWU2NjQ1MWY4MWM5ZGY5OWRiZGM5YjIzYmQ3NWQwMDczODBmNGUifQ== Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdrZV9jb25uZWN0LWdhdGV3YXktdjEvLk93bEJvdC55YW1sIiwiaCI6ImQ5YWU2NjQ1MWY4MWM5ZGY5OWRiZGM5YjIzYmQ3NWQwMDczODBmNGUifQ== Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdrZV9jb25uZWN0LWdhdGV3YXktdjFiZXRhMS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdrZV9odWItdjFiZXRhMS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdrZV9tdWx0aV9jbG91ZC12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdrZV9yZWNvbW1lbmRlci12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWdzdWl0ZV9hZGRfb25zLXYxLy5Pd2xCb3QueWFtbCIsImgiOiJkOWFlNjY0NTFmODFjOWRmOTlkYmRjOWIyM2JkNzVkMDA3MzgwZjRlIn0= Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWh5cGVyY29tcHV0ZV9jbHVzdGVyLXYxYmV0YS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWlhcC12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWlkcy12MS8uT3dsQm90LnlhbWwiLCJoIjoiZDlhZTY2NDUxZjgxYzlkZjk5ZGJkYzliMjNiZDc1ZDAwNzM4MGY0ZSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 429ea41 commit dedd71f

20 files changed

Lines changed: 80 additions & 0 deletions

File tree

  • google-cloud-essential_contacts-v1/proto_docs/google/api
  • google-cloud-eventarc-publishing-v1/proto_docs/google/api
  • google-cloud-eventarc-v1/proto_docs/google/api
  • google-cloud-filestore-v1/proto_docs/google/api
  • google-cloud-financial_services-v1/proto_docs/google/api
  • google-cloud-firestore-admin-v1/proto_docs/google/api
  • google-cloud-functions-v1/proto_docs/google/api
  • google-cloud-functions-v2/proto_docs/google/api
  • google-cloud-gdc_hardware_management-v1alpha/proto_docs/google/api
  • google-cloud-gemini_data_analytics-v1beta/proto_docs/google/api
  • google-cloud-gke_backup-v1/proto_docs/google/api
  • google-cloud-gke_connect-gateway-v1beta1/proto_docs/google/api
  • google-cloud-gke_connect-gateway-v1/proto_docs/google/api
  • google-cloud-gke_hub-v1beta1/proto_docs/google/api
  • google-cloud-gke_multi_cloud-v1/proto_docs/google/api
  • google-cloud-gke_recommender-v1/proto_docs/google/api
  • google-cloud-gsuite_add_ons-v1/proto_docs/google/api
  • google-cloud-hypercompute_cluster-v1beta/proto_docs/google/api
  • google-cloud-iap-v1/proto_docs/google/api
  • google-cloud-ids-v1/proto_docs/google/api

google-cloud-essential_contacts-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-eventarc-publishing-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-eventarc-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-filestore-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-financial_services-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-firestore-admin-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-functions-v1/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-functions-v2/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-gdc_hardware_management-v1alpha/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

google-cloud-gemini_data_analytics-v1beta/proto_docs/google/api/client.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -441,6 +443,8 @@ class LongRunning
441443

442444
# This message is used to configure the generation of a subset of the RPCs in
443445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
444448
# @!attribute [rw] methods
445449
# @return [::Array<::String>]
446450
# An allowlist of the fully qualified names of RPCs that should be included

0 commit comments

Comments
 (0)