google-cloud-dataplex-v1 0.5.0 → 0.5.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c9c6da3ad2ddcc67665849d27eb39c1bfb7d5de47ea6e29415d165014d2eef88
4
- data.tar.gz: fe559fdc880f44d102ccd2f71bf22801d5abe3bf991f0f22a49d271cf42b6e90
3
+ metadata.gz: 13e349aeb50f91378386cc70171e04d96875937d68261a25e75ad9f9b5190ca8
4
+ data.tar.gz: 63eb19ce2792f51f837fbbf7b042e77da11f7af5353478199e9b30e77661f6eb
5
5
  SHA512:
6
- metadata.gz: 3edafb5fb059618c8b02063b2c6acac7e88424df75855aa094e91d3809e445f8e18703f22a65705e26bf7fda0ddeb6db1d5f22bb39061e11c8e6b15e3b2d4d04
7
- data.tar.gz: a99005faba092b281cf99cf467b88d87c69ca50699dcea6672790f59d21a09184f045b4eec84d272645980e197b584619e1c95f9570edafccceb8756b95d399a
6
+ metadata.gz: 23673ad39cad43faea2e7301b4fb1751afb521e2993444858581d6f0f6535effbc87a0607708c397ac78eed0cb6a5c09a21c2be8875e69e7f288c5c12088ce8b
7
+ data.tar.gz: 8b72e94048913e5ca9137ec1a570c9e87d275284085c1f4cb35111818719a981b0deafe88fb986a0a4ba08c6963134ba6aaf954f1a22de72d24b01263a94d4d1
data/README.md CHANGED
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -873,12 +873,12 @@ module Google
873
873
  # Required. The resource name of the parent lake:
874
874
  # projects/\\{project_id}/locations/\\{location_id}/lakes/\\{lake_id}
875
875
  # @param page_size [::Integer]
876
- # Optional. Maximum number of content to return. The service may return fewer than
877
- # this value. If unspecified, at most 10 content will be returned. The
876
+ # Optional. Maximum number of content to return. The service may return fewer
877
+ # than this value. If unspecified, at most 10 content will be returned. The
878
878
  # maximum value is 1000; values above 1000 will be coerced to 1000.
879
879
  # @param page_token [::String]
880
- # Optional. Page token received from a previous `ListContent` call. Provide this
881
- # to retrieve the subsequent page. When paginating, all other parameters
880
+ # Optional. Page token received from a previous `ListContent` call. Provide
881
+ # this to retrieve the subsequent page. When paginating, all other parameters
882
882
  # provided to `ListContent` must match the call that provided the page
883
883
  # token.
884
884
  # @param filter [::String]
@@ -622,12 +622,12 @@ module Google
622
622
  # `projects/{project_number}/locations/{location_id}`
623
623
  # where `location_id` refers to a GCP region.
624
624
  # @param page_size [::Integer]
625
- # Optional. Maximum number of Lakes to return. The service may return fewer than this
626
- # value. If unspecified, at most 10 lakes will be returned. The maximum
627
- # value is 1000; values above 1000 will be coerced to 1000.
625
+ # Optional. Maximum number of Lakes to return. The service may return fewer
626
+ # than this value. If unspecified, at most 10 lakes will be returned. The
627
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
628
628
  # @param page_token [::String]
629
- # Optional. Page token received from a previous `ListLakes` call. Provide this to
630
- # retrieve the subsequent page. When paginating, all other parameters
629
+ # Optional. Page token received from a previous `ListLakes` call. Provide
630
+ # this to retrieve the subsequent page. When paginating, all other parameters
631
631
  # provided to `ListLakes` must match the call that provided the page token.
632
632
  # @param filter [::String]
633
633
  # Optional. Filter request.
@@ -813,14 +813,14 @@ module Google
813
813
  # Required. The resource name of the parent lake:
814
814
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
815
815
  # @param page_size [::Integer]
816
- # Optional. Maximum number of actions to return. The service may return fewer than this
817
- # value. If unspecified, at most 10 actions will be returned. The maximum
818
- # value is 1000; values above 1000 will be coerced to 1000.
816
+ # Optional. Maximum number of actions to return. The service may return fewer
817
+ # than this value. If unspecified, at most 10 actions will be returned. The
818
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
819
819
  # @param page_token [::String]
820
- # Optional. Page token received from a previous `ListLakeActions` call. Provide this to
821
- # retrieve the subsequent page. When paginating, all other parameters
822
- # provided to `ListLakeActions` must match the call that provided the page
823
- # token.
820
+ # Optional. Page token received from a previous `ListLakeActions` call.
821
+ # Provide this to retrieve the subsequent page. When paginating, all other
822
+ # parameters provided to `ListLakeActions` must match the call that provided
823
+ # the page token.
824
824
  #
825
825
  # @yield [response, operation] Access the result along with the RPC operation
826
826
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Action>]
@@ -1218,12 +1218,12 @@ module Google
1218
1218
  # Required. The resource name of the parent lake:
1219
1219
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
1220
1220
  # @param page_size [::Integer]
1221
- # Optional. Maximum number of zones to return. The service may return fewer than this
1222
- # value. If unspecified, at most 10 zones will be returned. The maximum
1223
- # value is 1000; values above 1000 will be coerced to 1000.
1221
+ # Optional. Maximum number of zones to return. The service may return fewer
1222
+ # than this value. If unspecified, at most 10 zones will be returned. The
1223
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
1224
1224
  # @param page_token [::String]
1225
- # Optional. Page token received from a previous `ListZones` call. Provide this to
1226
- # retrieve the subsequent page. When paginating, all other parameters
1225
+ # Optional. Page token received from a previous `ListZones` call. Provide
1226
+ # this to retrieve the subsequent page. When paginating, all other parameters
1227
1227
  # provided to `ListZones` must match the call that provided the page token.
1228
1228
  # @param filter [::String]
1229
1229
  # Optional. Filter request.
@@ -1409,14 +1409,14 @@ module Google
1409
1409
  # Required. The resource name of the parent zone:
1410
1410
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
1411
1411
  # @param page_size [::Integer]
1412
- # Optional. Maximum number of actions to return. The service may return fewer than this
1413
- # value. If unspecified, at most 10 actions will be returned. The maximum
1414
- # value is 1000; values above 1000 will be coerced to 1000.
1412
+ # Optional. Maximum number of actions to return. The service may return fewer
1413
+ # than this value. If unspecified, at most 10 actions will be returned. The
1414
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
1415
1415
  # @param page_token [::String]
1416
- # Optional. Page token received from a previous `ListZoneActions` call. Provide this to
1417
- # retrieve the subsequent page. When paginating, all other parameters
1418
- # provided to `ListZoneActions` must match the call that provided the page
1419
- # token.
1416
+ # Optional. Page token received from a previous `ListZoneActions` call.
1417
+ # Provide this to retrieve the subsequent page. When paginating, all other
1418
+ # parameters provided to `ListZoneActions` must match the call that provided
1419
+ # the page token.
1420
1420
  #
1421
1421
  # @yield [response, operation] Access the result along with the RPC operation
1422
1422
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Action>]
@@ -1813,12 +1813,12 @@ module Google
1813
1813
  # Required. The resource name of the parent zone:
1814
1814
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
1815
1815
  # @param page_size [::Integer]
1816
- # Optional. Maximum number of asset to return. The service may return fewer than
1817
- # this value. If unspecified, at most 10 assets will be returned. The
1816
+ # Optional. Maximum number of asset to return. The service may return fewer
1817
+ # than this value. If unspecified, at most 10 assets will be returned. The
1818
1818
  # maximum value is 1000; values above 1000 will be coerced to 1000.
1819
1819
  # @param page_token [::String]
1820
- # Optional. Page token received from a previous `ListAssets` call. Provide this to
1821
- # retrieve the subsequent page. When paginating, all other parameters
1820
+ # Optional. Page token received from a previous `ListAssets` call. Provide
1821
+ # this to retrieve the subsequent page. When paginating, all other parameters
1822
1822
  # provided to `ListAssets` must match the call that provided the page
1823
1823
  # token.
1824
1824
  # @param filter [::String]
@@ -2005,14 +2005,14 @@ module Google
2005
2005
  # Required. The resource name of the parent asset:
2006
2006
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.
2007
2007
  # @param page_size [::Integer]
2008
- # Optional. Maximum number of actions to return. The service may return fewer than this
2009
- # value. If unspecified, at most 10 actions will be returned. The maximum
2010
- # value is 1000; values above 1000 will be coerced to 1000.
2008
+ # Optional. Maximum number of actions to return. The service may return fewer
2009
+ # than this value. If unspecified, at most 10 actions will be returned. The
2010
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
2011
2011
  # @param page_token [::String]
2012
- # Optional. Page token received from a previous `ListAssetActions` call. Provide this
2013
- # to retrieve the subsequent page. When paginating, all other parameters
2014
- # provided to `ListAssetActions` must match the call that provided the page
2015
- # token.
2012
+ # Optional. Page token received from a previous `ListAssetActions` call.
2013
+ # Provide this to retrieve the subsequent page. When paginating, all other
2014
+ # parameters provided to `ListAssetActions` must match the call that provided
2015
+ # the page token.
2016
2016
  #
2017
2017
  # @yield [response, operation] Access the result along with the RPC operation
2018
2018
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::Action>]
@@ -2401,12 +2401,12 @@ module Google
2401
2401
  # Required. The resource name of the parent lake:
2402
2402
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
2403
2403
  # @param page_size [::Integer]
2404
- # Optional. Maximum number of tasks to return. The service may return fewer than this
2405
- # value. If unspecified, at most 10 tasks will be returned. The maximum
2406
- # value is 1000; values above 1000 will be coerced to 1000.
2404
+ # Optional. Maximum number of tasks to return. The service may return fewer
2405
+ # than this value. If unspecified, at most 10 tasks will be returned. The
2406
+ # maximum value is 1000; values above 1000 will be coerced to 1000.
2407
2407
  # @param page_token [::String]
2408
- # Optional. Page token received from a previous `ListZones` call. Provide this to
2409
- # retrieve the subsequent page. When paginating, all other parameters
2408
+ # Optional. Page token received from a previous `ListZones` call. Provide
2409
+ # this to retrieve the subsequent page. When paginating, all other parameters
2410
2410
  # provided to `ListZones` must match the call that provided the page token.
2411
2411
  # @param filter [::String]
2412
2412
  # Optional. Filter request.
@@ -2592,12 +2592,12 @@ module Google
2592
2592
  # Required. The resource name of the parent environment:
2593
2593
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
2594
2594
  # @param page_size [::Integer]
2595
- # Optional. Maximum number of jobs to return. The service may return fewer than
2596
- # this value. If unspecified, at most 10 jobs will be returned. The
2595
+ # Optional. Maximum number of jobs to return. The service may return fewer
2596
+ # than this value. If unspecified, at most 10 jobs will be returned. The
2597
2597
  # maximum value is 1000; values above 1000 will be coerced to 1000.
2598
2598
  # @param page_token [::String]
2599
- # Optional. Page token received from a previous `ListJobs` call. Provide this to
2600
- # retrieve the subsequent page. When paginating, all other parameters
2599
+ # Optional. Page token received from a previous `ListJobs` call. Provide this
2600
+ # to retrieve the subsequent page. When paginating, all other parameters
2601
2601
  # provided to `ListJobs` must match the call that provided the page
2602
2602
  # token.
2603
2603
  #
@@ -3166,14 +3166,15 @@ module Google
3166
3166
  # Required. The resource name of the parent lake:
3167
3167
  # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`.
3168
3168
  # @param page_size [::Integer]
3169
- # Optional. Maximum number of environments to return. The service may return fewer than
3170
- # this value. If unspecified, at most 10 environments will be returned. The
3171
- # maximum value is 1000; values above 1000 will be coerced to 1000.
3169
+ # Optional. Maximum number of environments to return. The service may return
3170
+ # fewer than this value. If unspecified, at most 10 environments will be
3171
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
3172
+ # 1000.
3172
3173
  # @param page_token [::String]
3173
- # Optional. Page token received from a previous `ListEnvironments` call. Provide this
3174
- # to retrieve the subsequent page. When paginating, all other parameters
3175
- # provided to `ListEnvironments` must match the call that provided the page
3176
- # token.
3174
+ # Optional. Page token received from a previous `ListEnvironments` call.
3175
+ # Provide this to retrieve the subsequent page. When paginating, all other
3176
+ # parameters provided to `ListEnvironments` must match the call that provided
3177
+ # the page token.
3177
3178
  # @param filter [::String]
3178
3179
  # Optional. Filter request.
3179
3180
  # @param order_by [::String]
@@ -3358,22 +3359,22 @@ module Google
3358
3359
  # Required. The resource name of the parent environment:
3359
3360
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.
3360
3361
  # @param page_size [::Integer]
3361
- # Optional. Maximum number of sessions to return. The service may return fewer than
3362
- # this value. If unspecified, at most 10 sessions will be returned. The
3363
- # maximum value is 1000; values above 1000 will be coerced to 1000.
3362
+ # Optional. Maximum number of sessions to return. The service may return
3363
+ # fewer than this value. If unspecified, at most 10 sessions will be
3364
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
3365
+ # 1000.
3364
3366
  # @param page_token [::String]
3365
- # Optional. Page token received from a previous `ListSessions` call. Provide this to
3366
- # retrieve the subsequent page. When paginating, all other parameters
3367
+ # Optional. Page token received from a previous `ListSessions` call. Provide
3368
+ # this to retrieve the subsequent page. When paginating, all other parameters
3367
3369
  # provided to `ListSessions` must match the call that provided the page
3368
3370
  # token.
3369
3371
  # @param filter [::String]
3370
- # Optional. Filter request. The following `mode` filter is supported to return only the
3371
- # sessions belonging to the requester when the mode is USER and return
3372
- # sessions of all the users when the mode is ADMIN. When no filter is sent
3373
- # default to USER mode.
3374
- # NOTE: When the mode is ADMIN, the requester should have
3375
- # `dataplex.environments.listAllSessions` permission to list all sessions,
3376
- # in absence of the permission, the request fails.
3372
+ # Optional. Filter request. The following `mode` filter is supported to
3373
+ # return only the sessions belonging to the requester when the mode is USER
3374
+ # and return sessions of all the users when the mode is ADMIN. When no filter
3375
+ # is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
3376
+ # should have `dataplex.environments.listAllSessions` permission to list all
3377
+ # sessions, in absence of the permission, the request fails.
3377
3378
  #
3378
3379
  # mode = ADMIN | USER
3379
3380
  #
@@ -404,8 +404,8 @@ module Google
404
404
  # Required. The resource name of the entity:
405
405
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
406
406
  # @param etag [::String]
407
- # Required. The etag associated with the entity, which can be retrieved with a
408
- # [GetEntity][] request.
407
+ # Required. The etag associated with the entity, which can be retrieved with
408
+ # a [GetEntity][] request.
409
409
  #
410
410
  # @yield [response, operation] Access the result along with the RPC operation
411
411
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -584,17 +584,18 @@ module Google
584
584
  # @param view [::Google::Cloud::Dataplex::V1::ListEntitiesRequest::EntityView]
585
585
  # Required. Specify the entity view to make a partial list request.
586
586
  # @param page_size [::Integer]
587
- # Optional. Maximum number of entities to return. The service may return fewer than
588
- # this value. If unspecified, 100 entities will be returned by default. The
589
- # maximum value is 500; larger values will will be truncated to 500.
587
+ # Optional. Maximum number of entities to return. The service may return
588
+ # fewer than this value. If unspecified, 100 entities will be returned by
589
+ # default. The maximum value is 500; larger values will will be truncated to
590
+ # 500.
590
591
  # @param page_token [::String]
591
592
  # Optional. Page token received from a previous `ListEntities` call. Provide
592
593
  # this to retrieve the subsequent page. When paginating, all other parameters
593
594
  # provided to `ListEntities` must match the call that provided the
594
595
  # page token.
595
596
  # @param filter [::String]
596
- # Optional. The following filter parameters can be added to the URL to limit the
597
- # entities returned by the API:
597
+ # Optional. The following filter parameters can be added to the URL to limit
598
+ # the entities returned by the API:
598
599
  #
599
600
  # - Entity ID: ?filter="id=entityID"
600
601
  # - Asset ID: ?filter="asset=assetID"
@@ -965,17 +966,18 @@ module Google
965
966
  # Required. The resource name of the parent entity:
966
967
  # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
967
968
  # @param page_size [::Integer]
968
- # Optional. Maximum number of partitions to return. The service may return fewer than
969
- # this value. If unspecified, 100 partitions will be returned by default. The
970
- # maximum page size is 500; larger values will will be truncated to 500.
969
+ # Optional. Maximum number of partitions to return. The service may return
970
+ # fewer than this value. If unspecified, 100 partitions will be returned by
971
+ # default. The maximum page size is 500; larger values will will be truncated
972
+ # to 500.
971
973
  # @param page_token [::String]
972
- # Optional. Page token received from a previous `ListPartitions` call. Provide
973
- # this to retrieve the subsequent page. When paginating, all other parameters
974
- # provided to `ListPartitions` must match the call that provided the
975
- # page token.
974
+ # Optional. Page token received from a previous `ListPartitions` call.
975
+ # Provide this to retrieve the subsequent page. When paginating, all other
976
+ # parameters provided to `ListPartitions` must match the call that provided
977
+ # the page token.
976
978
  # @param filter [::String]
977
- # Optional. Filter the partitions returned to the caller using a key value pair
978
- # expression. Supported operators and syntax:
979
+ # Optional. Filter the partitions returned to the caller using a key value
980
+ # pair expression. Supported operators and syntax:
979
981
  #
980
982
  # - logic operators: AND, OR
981
983
  # - comparison operators: <, >, >=, <= ,=, !=
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dataplex
23
23
  module V1
24
- VERSION = "0.5.0"
24
+ VERSION = "0.5.1"
25
25
  end
26
26
  end
27
27
  end
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end