google-cloud-storage_transfer-v1 0.7.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb +42 -9
  4. data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/operations.rb +38 -7
  5. data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb +273 -7
  6. data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/operations.rb +108 -8
  7. data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/storage_transfer/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +14 -0
  10. data/proto_docs/google/api/field_behavior.rb +14 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: af7725237df5c5ef0673811dd3ebf384df3adfca2735c77dcbba090bff65fd3e
4
- data.tar.gz: d6a6622e66087d34beccd36f184b0928beea1b562c8170ed753c261c1140aedb
3
+ metadata.gz: 7ee463777abc8e013bfeb1ebfe6b5c9ae2aa43c6dad5ca965b97e0b80a358506
4
+ data.tar.gz: 0d59e875c3b59afc2fc96f7676c015b46cff0c78ce409d6aa378d196c5210b3a
5
5
  SHA512:
6
- metadata.gz: 3d9e6935bbe7dc97b515e9e5682f4df28842537dd1746960fcc038fc649701b1546d81c04f30987a3f4ba7da715fa803ba3705091b4de2845dc37197bfff8d04
7
- data.tar.gz: 4f75bfc6e724e52509a4f6906cb0dce607ba8126c934de8989c2f4ce0568cb4e98e9e9ed15da458b8698c778f1ae6837e1f62a6920072c6a5e8ce975077d5953
6
+ metadata.gz: 310ecc2d164dcdff8620733a829866689d91e66525c145e926954279062717bae87713b0a5977ea289f03ae25690419174faee0db9dc79048506219806af7bf6
7
+ data.tar.gz: 35c1f2e1bdea0cd64d709491e70cf2b3acd09e14a625fa6cd63ac689d4c5f8f3c859b973ecdc3e518fd863f1c372a343d5b9a6030e59381941a8718fc5d7f597
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-storage_transfer-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-storage_transfer-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/storage_transfer/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-storage_transfer-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-storage_transfer-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-storage_transfer-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::StorageTransfer::V1::StorageTransferService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
72
41
 
73
- ```ruby
74
- require "google/cloud/storage_transfer/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new
79
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
80
49
 
81
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/storage_transfer/v1"
88
58
 
89
59
  client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/storage_transfer/v1"
98
68
 
99
69
  ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
111
82
 
112
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-storage_transfer-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/storage_transfer/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-storage_transfer-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # source external to Google to a Cloud Storage bucket.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "storagetransfer.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -99,6 +102,15 @@ module Google
99
102
  @config
100
103
  end
101
104
 
105
+ ##
106
+ # The effective universe domain
107
+ #
108
+ # @return [String]
109
+ #
110
+ def universe_domain
111
+ @storage_transfer_service_stub.universe_domain
112
+ end
113
+
102
114
  ##
103
115
  # Create a new StorageTransferService client object.
104
116
  #
@@ -132,8 +144,9 @@ module Google
132
144
  credentials = @config.credentials
133
145
  # Use self-signed JWT if the endpoint is unchanged from default,
134
146
  # but only if the default endpoint does not have a region prefix.
135
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
- !@config.endpoint.split(".").first.include?("-")
147
+ enable_self_signed_jwt = @config.endpoint.nil? ||
148
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
149
+ !@config.endpoint.split(".").first.include?("-"))
137
150
  credentials ||= Credentials.default scope: @config.scope,
138
151
  enable_self_signed_jwt: enable_self_signed_jwt
139
152
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -146,14 +159,18 @@ module Google
146
159
  config.credentials = credentials
147
160
  config.quota_project = @quota_project_id
148
161
  config.endpoint = @config.endpoint
162
+ config.universe_domain = @config.universe_domain
149
163
  end
150
164
 
151
165
  @storage_transfer_service_stub = ::Gapic::ServiceStub.new(
152
166
  ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Stub,
153
- credentials: credentials,
154
- endpoint: @config.endpoint,
167
+ credentials: credentials,
168
+ endpoint: @config.endpoint,
169
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
170
+ universe_domain: @config.universe_domain,
155
171
  channel_args: @config.channel_args,
156
- interceptors: @config.interceptors
172
+ interceptors: @config.interceptors,
173
+ channel_pool_config: @config.channel_pool
157
174
  )
158
175
  end
159
176
 
@@ -1507,9 +1524,9 @@ module Google
1507
1524
  # end
1508
1525
  #
1509
1526
  # @!attribute [rw] endpoint
1510
- # The hostname or hostname:port of the service endpoint.
1511
- # Defaults to `"storagetransfer.googleapis.com"`.
1512
- # @return [::String]
1527
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1528
+ # nil, indicating to use the default endpoint in the current universe domain.
1529
+ # @return [::String,nil]
1513
1530
  # @!attribute [rw] credentials
1514
1531
  # Credentials to send with calls. You may provide any of the following types:
1515
1532
  # * (`String`) The path to a service account key file in JSON format
@@ -1555,13 +1572,20 @@ module Google
1555
1572
  # @!attribute [rw] quota_project
1556
1573
  # A separate project against which to charge quota.
1557
1574
  # @return [::String]
1575
+ # @!attribute [rw] universe_domain
1576
+ # The universe domain within which to make requests. This determines the
1577
+ # default endpoint URL. The default value of nil uses the environment
1578
+ # universe (usually the default "googleapis.com" universe).
1579
+ # @return [::String,nil]
1558
1580
  #
1559
1581
  class Configuration
1560
1582
  extend ::Gapic::Config
1561
1583
 
1584
+ # @private
1585
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1562
1586
  DEFAULT_ENDPOINT = "storagetransfer.googleapis.com"
1563
1587
 
1564
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1588
+ config_attr :endpoint, nil, ::String, nil
1565
1589
  config_attr :credentials, nil do |value|
1566
1590
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1567
1591
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1576,6 +1600,7 @@ module Google
1576
1600
  config_attr :metadata, nil, ::Hash, nil
1577
1601
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1578
1602
  config_attr :quota_project, nil, ::String, nil
1603
+ config_attr :universe_domain, nil, ::String, nil
1579
1604
 
1580
1605
  # @private
1581
1606
  def initialize parent_config = nil
@@ -1596,6 +1621,14 @@ module Google
1596
1621
  end
1597
1622
  end
1598
1623
 
1624
+ ##
1625
+ # Configuration for the channel pool
1626
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1627
+ #
1628
+ def channel_pool
1629
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1630
+ end
1631
+
1599
1632
  ##
1600
1633
  # Configuration RPC class for the StorageTransferService API.
1601
1634
  #
data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module StorageTransferService
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "storagetransfer.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,10 +102,13 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
- interceptors: @config.interceptors
110
+ interceptors: @config.interceptors,
111
+ channel_pool_config: @config.channel_pool
97
112
  )
98
113
 
99
114
  # Used by an LRO wrapper for some methods of this service
@@ -612,9 +627,9 @@ module Google
612
627
  # end
613
628
  #
614
629
  # @!attribute [rw] endpoint
615
- # The hostname or hostname:port of the service endpoint.
616
- # Defaults to `"storagetransfer.googleapis.com"`.
617
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
618
633
  # @!attribute [rw] credentials
619
634
  # Credentials to send with calls. You may provide any of the following types:
620
635
  # * (`String`) The path to a service account key file in JSON format
@@ -660,13 +675,20 @@ module Google
660
675
  # @!attribute [rw] quota_project
661
676
  # A separate project against which to charge quota.
662
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
663
683
  #
664
684
  class Configuration
665
685
  extend ::Gapic::Config
666
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
667
689
  DEFAULT_ENDPOINT = "storagetransfer.googleapis.com"
668
690
 
669
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
670
692
  config_attr :credentials, nil do |value|
671
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -681,6 +703,7 @@ module Google
681
703
  config_attr :metadata, nil, ::Hash, nil
682
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
683
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
684
707
 
685
708
  # @private
686
709
  def initialize parent_config = nil
@@ -701,6 +724,14 @@ module Google
701
724
  end
702
725
  end
703
726
 
727
+ ##
728
+ # Configuration for the channel pool
729
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
730
+ #
731
+ def channel_pool
732
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
733
+ end
734
+
704
735
  ##
705
736
  # Configuration RPC class for the Operations API.
706
737
  #
data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # source external to Google to a Cloud Storage bucket.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "storagetransfer.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -101,6 +104,15 @@ module Google
101
104
  @config
102
105
  end
103
106
 
107
+ ##
108
+ # The effective universe domain
109
+ #
110
+ # @return [String]
111
+ #
112
+ def universe_domain
113
+ @storage_transfer_service_stub.universe_domain
114
+ end
115
+
104
116
  ##
105
117
  # Create a new StorageTransferService REST client object.
106
118
  #
@@ -128,8 +140,9 @@ module Google
128
140
  credentials = @config.credentials
129
141
  # Use self-signed JWT if the endpoint is unchanged from default,
130
142
  # but only if the default endpoint does not have a region prefix.
131
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
132
- !@config.endpoint.split(".").first.include?("-")
143
+ enable_self_signed_jwt = @config.endpoint.nil? ||
144
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
145
+ !@config.endpoint.split(".").first.include?("-"))
133
146
  credentials ||= Credentials.default scope: @config.scope,
134
147
  enable_self_signed_jwt: enable_self_signed_jwt
135
148
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -143,9 +156,15 @@ module Google
143
156
  config.credentials = credentials
144
157
  config.quota_project = @quota_project_id
145
158
  config.endpoint = @config.endpoint
159
+ config.universe_domain = @config.universe_domain
146
160
  end
147
161
 
148
- @storage_transfer_service_stub = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
162
+ @storage_transfer_service_stub = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::ServiceStub.new(
163
+ endpoint: @config.endpoint,
164
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
165
+ universe_domain: @config.universe_domain,
166
+ credentials: credentials
167
+ )
149
168
  end
150
169
 
151
170
  ##
@@ -192,6 +211,22 @@ module Google
192
211
  # @return [::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount]
193
212
  #
194
213
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
214
+ #
215
+ # @example Basic example
216
+ # require "google/cloud/storage_transfer/v1"
217
+ #
218
+ # # Create a client object. The client can be reused for multiple calls.
219
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
220
+ #
221
+ # # Create a request. To set request fields, pass in keyword arguments.
222
+ # request = Google::Cloud::StorageTransfer::V1::GetGoogleServiceAccountRequest.new
223
+ #
224
+ # # Call the get_google_service_account method.
225
+ # result = client.get_google_service_account request
226
+ #
227
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::GoogleServiceAccount.
228
+ # p result
229
+ #
195
230
  def get_google_service_account request, options = nil
196
231
  raise ::ArgumentError, "request must be provided" if request.nil?
197
232
 
@@ -254,6 +289,22 @@ module Google
254
289
  # @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
255
290
  #
256
291
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
292
+ #
293
+ # @example Basic example
294
+ # require "google/cloud/storage_transfer/v1"
295
+ #
296
+ # # Create a client object. The client can be reused for multiple calls.
297
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
298
+ #
299
+ # # Create a request. To set request fields, pass in keyword arguments.
300
+ # request = Google::Cloud::StorageTransfer::V1::CreateTransferJobRequest.new
301
+ #
302
+ # # Call the create_transfer_job method.
303
+ # result = client.create_transfer_job request
304
+ #
305
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
306
+ # p result
307
+ #
257
308
  def create_transfer_job request, options = nil
258
309
  raise ::ArgumentError, "request must be provided" if request.nil?
259
310
 
@@ -351,6 +402,22 @@ module Google
351
402
  # @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
352
403
  #
353
404
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
405
+ #
406
+ # @example Basic example
407
+ # require "google/cloud/storage_transfer/v1"
408
+ #
409
+ # # Create a client object. The client can be reused for multiple calls.
410
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
411
+ #
412
+ # # Create a request. To set request fields, pass in keyword arguments.
413
+ # request = Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest.new
414
+ #
415
+ # # Call the update_transfer_job method.
416
+ # result = client.update_transfer_job request
417
+ #
418
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
419
+ # p result
420
+ #
354
421
  def update_transfer_job request, options = nil
355
422
  raise ::ArgumentError, "request must be provided" if request.nil?
356
423
 
@@ -416,6 +483,22 @@ module Google
416
483
  # @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
417
484
  #
418
485
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
486
+ #
487
+ # @example Basic example
488
+ # require "google/cloud/storage_transfer/v1"
489
+ #
490
+ # # Create a client object. The client can be reused for multiple calls.
491
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
492
+ #
493
+ # # Create a request. To set request fields, pass in keyword arguments.
494
+ # request = Google::Cloud::StorageTransfer::V1::GetTransferJobRequest.new
495
+ #
496
+ # # Call the get_transfer_job method.
497
+ # result = client.get_transfer_job request
498
+ #
499
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
500
+ # p result
501
+ #
419
502
  def get_transfer_job request, options = nil
420
503
  raise ::ArgumentError, "request must be provided" if request.nil?
421
504
 
@@ -493,6 +576,26 @@ module Google
493
576
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>]
494
577
  #
495
578
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
579
+ #
580
+ # @example Basic example
581
+ # require "google/cloud/storage_transfer/v1"
582
+ #
583
+ # # Create a client object. The client can be reused for multiple calls.
584
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
585
+ #
586
+ # # Create a request. To set request fields, pass in keyword arguments.
587
+ # request = Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest.new
588
+ #
589
+ # # Call the list_transfer_jobs method.
590
+ # result = client.list_transfer_jobs request
591
+ #
592
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
593
+ # # over elements, and API calls will be issued to fetch pages as needed.
594
+ # result.each do |item|
595
+ # # Each element is of type ::Google::Cloud::StorageTransfer::V1::TransferJob.
596
+ # p item
597
+ # end
598
+ #
496
599
  def list_transfer_jobs request, options = nil
497
600
  raise ::ArgumentError, "request must be provided" if request.nil?
498
601
 
@@ -556,6 +659,22 @@ module Google
556
659
  # @return [::Google::Protobuf::Empty]
557
660
  #
558
661
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
662
+ #
663
+ # @example Basic example
664
+ # require "google/cloud/storage_transfer/v1"
665
+ #
666
+ # # Create a client object. The client can be reused for multiple calls.
667
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
668
+ #
669
+ # # Create a request. To set request fields, pass in keyword arguments.
670
+ # request = Google::Cloud::StorageTransfer::V1::PauseTransferOperationRequest.new
671
+ #
672
+ # # Call the pause_transfer_operation method.
673
+ # result = client.pause_transfer_operation request
674
+ #
675
+ # # The returned object is of type Google::Protobuf::Empty.
676
+ # p result
677
+ #
559
678
  def pause_transfer_operation request, options = nil
560
679
  raise ::ArgumentError, "request must be provided" if request.nil?
561
680
 
@@ -618,6 +737,22 @@ module Google
618
737
  # @return [::Google::Protobuf::Empty]
619
738
  #
620
739
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
740
+ #
741
+ # @example Basic example
742
+ # require "google/cloud/storage_transfer/v1"
743
+ #
744
+ # # Create a client object. The client can be reused for multiple calls.
745
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
746
+ #
747
+ # # Create a request. To set request fields, pass in keyword arguments.
748
+ # request = Google::Cloud::StorageTransfer::V1::ResumeTransferOperationRequest.new
749
+ #
750
+ # # Call the resume_transfer_operation method.
751
+ # result = client.resume_transfer_operation request
752
+ #
753
+ # # The returned object is of type Google::Protobuf::Empty.
754
+ # p result
755
+ #
621
756
  def resume_transfer_operation request, options = nil
622
757
  raise ::ArgumentError, "request must be provided" if request.nil?
623
758
 
@@ -686,6 +821,29 @@ module Google
686
821
  # @return [::Gapic::Operation]
687
822
  #
688
823
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
824
+ #
825
+ # @example Basic example
826
+ # require "google/cloud/storage_transfer/v1"
827
+ #
828
+ # # Create a client object. The client can be reused for multiple calls.
829
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
830
+ #
831
+ # # Create a request. To set request fields, pass in keyword arguments.
832
+ # request = Google::Cloud::StorageTransfer::V1::RunTransferJobRequest.new
833
+ #
834
+ # # Call the run_transfer_job method.
835
+ # result = client.run_transfer_job request
836
+ #
837
+ # # The returned object is of type Gapic::Operation. You can use it to
838
+ # # check the status of an operation, cancel it, or wait for results.
839
+ # # Here is how to wait for a response.
840
+ # result.wait_until_done! timeout: 60
841
+ # if result.response?
842
+ # p result.response
843
+ # else
844
+ # puts "No response received."
845
+ # end
846
+ #
689
847
  def run_transfer_job request, options = nil
690
848
  raise ::ArgumentError, "request must be provided" if request.nil?
691
849
 
@@ -753,6 +911,22 @@ module Google
753
911
  # @return [::Google::Protobuf::Empty]
754
912
  #
755
913
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
914
+ #
915
+ # @example Basic example
916
+ # require "google/cloud/storage_transfer/v1"
917
+ #
918
+ # # Create a client object. The client can be reused for multiple calls.
919
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
920
+ #
921
+ # # Create a request. To set request fields, pass in keyword arguments.
922
+ # request = Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest.new
923
+ #
924
+ # # Call the delete_transfer_job method.
925
+ # result = client.delete_transfer_job request
926
+ #
927
+ # # The returned object is of type Google::Protobuf::Empty.
928
+ # p result
929
+ #
756
930
  def delete_transfer_job request, options = nil
757
931
  raise ::ArgumentError, "request must be provided" if request.nil?
758
932
 
@@ -832,6 +1006,22 @@ module Google
832
1006
  # @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
833
1007
  #
834
1008
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1009
+ #
1010
+ # @example Basic example
1011
+ # require "google/cloud/storage_transfer/v1"
1012
+ #
1013
+ # # Create a client object. The client can be reused for multiple calls.
1014
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
1015
+ #
1016
+ # # Create a request. To set request fields, pass in keyword arguments.
1017
+ # request = Google::Cloud::StorageTransfer::V1::CreateAgentPoolRequest.new
1018
+ #
1019
+ # # Call the create_agent_pool method.
1020
+ # result = client.create_agent_pool request
1021
+ #
1022
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
1023
+ # p result
1024
+ #
835
1025
  def create_agent_pool request, options = nil
836
1026
  raise ::ArgumentError, "request must be provided" if request.nil?
837
1027
 
@@ -912,6 +1102,22 @@ module Google
912
1102
  # @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
913
1103
  #
914
1104
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1105
+ #
1106
+ # @example Basic example
1107
+ # require "google/cloud/storage_transfer/v1"
1108
+ #
1109
+ # # Create a client object. The client can be reused for multiple calls.
1110
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
1111
+ #
1112
+ # # Create a request. To set request fields, pass in keyword arguments.
1113
+ # request = Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest.new
1114
+ #
1115
+ # # Call the update_agent_pool method.
1116
+ # result = client.update_agent_pool request
1117
+ #
1118
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
1119
+ # p result
1120
+ #
915
1121
  def update_agent_pool request, options = nil
916
1122
  raise ::ArgumentError, "request must be provided" if request.nil?
917
1123
 
@@ -974,6 +1180,22 @@ module Google
974
1180
  # @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
975
1181
  #
976
1182
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1183
+ #
1184
+ # @example Basic example
1185
+ # require "google/cloud/storage_transfer/v1"
1186
+ #
1187
+ # # Create a client object. The client can be reused for multiple calls.
1188
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
1189
+ #
1190
+ # # Create a request. To set request fields, pass in keyword arguments.
1191
+ # request = Google::Cloud::StorageTransfer::V1::GetAgentPoolRequest.new
1192
+ #
1193
+ # # Call the get_agent_pool method.
1194
+ # result = client.get_agent_pool request
1195
+ #
1196
+ # # The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
1197
+ # p result
1198
+ #
977
1199
  def get_agent_pool request, options = nil
978
1200
  raise ::ArgumentError, "request must be provided" if request.nil?
979
1201
 
@@ -1049,6 +1271,26 @@ module Google
1049
1271
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>]
1050
1272
  #
1051
1273
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1274
+ #
1275
+ # @example Basic example
1276
+ # require "google/cloud/storage_transfer/v1"
1277
+ #
1278
+ # # Create a client object. The client can be reused for multiple calls.
1279
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
1280
+ #
1281
+ # # Create a request. To set request fields, pass in keyword arguments.
1282
+ # request = Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest.new
1283
+ #
1284
+ # # Call the list_agent_pools method.
1285
+ # result = client.list_agent_pools request
1286
+ #
1287
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1288
+ # # over elements, and API calls will be issued to fetch pages as needed.
1289
+ # result.each do |item|
1290
+ # # Each element is of type ::Google::Cloud::StorageTransfer::V1::AgentPool.
1291
+ # p item
1292
+ # end
1293
+ #
1052
1294
  def list_agent_pools request, options = nil
1053
1295
  raise ::ArgumentError, "request must be provided" if request.nil?
1054
1296
 
@@ -1112,6 +1354,22 @@ module Google
1112
1354
  # @return [::Google::Protobuf::Empty]
1113
1355
  #
1114
1356
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1357
+ #
1358
+ # @example Basic example
1359
+ # require "google/cloud/storage_transfer/v1"
1360
+ #
1361
+ # # Create a client object. The client can be reused for multiple calls.
1362
+ # client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
1363
+ #
1364
+ # # Create a request. To set request fields, pass in keyword arguments.
1365
+ # request = Google::Cloud::StorageTransfer::V1::DeleteAgentPoolRequest.new
1366
+ #
1367
+ # # Call the delete_agent_pool method.
1368
+ # result = client.delete_agent_pool request
1369
+ #
1370
+ # # The returned object is of type Google::Protobuf::Empty.
1371
+ # p result
1372
+ #
1115
1373
  def delete_agent_pool request, options = nil
1116
1374
  raise ::ArgumentError, "request must be provided" if request.nil?
1117
1375
 
@@ -1177,9 +1435,9 @@ module Google
1177
1435
  # end
1178
1436
  #
1179
1437
  # @!attribute [rw] endpoint
1180
- # The hostname or hostname:port of the service endpoint.
1181
- # Defaults to `"storagetransfer.googleapis.com"`.
1182
- # @return [::String]
1438
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1439
+ # nil, indicating to use the default endpoint in the current universe domain.
1440
+ # @return [::String,nil]
1183
1441
  # @!attribute [rw] credentials
1184
1442
  # Credentials to send with calls. You may provide any of the following types:
1185
1443
  # * (`String`) The path to a service account key file in JSON format
@@ -1216,13 +1474,20 @@ module Google
1216
1474
  # @!attribute [rw] quota_project
1217
1475
  # A separate project against which to charge quota.
1218
1476
  # @return [::String]
1477
+ # @!attribute [rw] universe_domain
1478
+ # The universe domain within which to make requests. This determines the
1479
+ # default endpoint URL. The default value of nil uses the environment
1480
+ # universe (usually the default "googleapis.com" universe).
1481
+ # @return [::String,nil]
1219
1482
  #
1220
1483
  class Configuration
1221
1484
  extend ::Gapic::Config
1222
1485
 
1486
+ # @private
1487
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1223
1488
  DEFAULT_ENDPOINT = "storagetransfer.googleapis.com"
1224
1489
 
1225
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1490
+ config_attr :endpoint, nil, ::String, nil
1226
1491
  config_attr :credentials, nil do |value|
1227
1492
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1228
1493
  allowed.any? { |klass| klass === value }
@@ -1234,6 +1499,7 @@ module Google
1234
1499
  config_attr :metadata, nil, ::Hash, nil
1235
1500
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1236
1501
  config_attr :quota_project, nil, ::String, nil
1502
+ config_attr :universe_domain, nil, ::String, nil
1237
1503
 
1238
1504
  # @private
1239
1505
  def initialize parent_config = nil
data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "storagetransfer.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -136,6 +150,26 @@ module Google
136
150
  # @return [::Gapic::Operation]
137
151
  #
138
152
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
153
+ #
154
+ # @example Basic example
155
+ # require "google/longrunning"
156
+ #
157
+ # # Create a client object. The client can be reused for multiple calls.
158
+ # client = Google::Longrunning::Operations::Rest::Client.new
159
+ #
160
+ # # Create a request. To set request fields, pass in keyword arguments.
161
+ # request = Google::Longrunning::ListOperationsRequest.new
162
+ #
163
+ # # Call the list_operations method.
164
+ # result = client.list_operations request
165
+ #
166
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
167
+ # # over elements, and API calls will be issued to fetch pages as needed.
168
+ # result.each do |item|
169
+ # # Each element is of type ::Google::Longrunning::Operation.
170
+ # p item
171
+ # end
172
+ #
139
173
  def list_operations request, options = nil
140
174
  raise ::ArgumentError, "request must be provided" if request.nil?
141
175
 
@@ -201,6 +235,29 @@ module Google
201
235
  # @return [::Gapic::Operation]
202
236
  #
203
237
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
238
+ #
239
+ # @example Basic example
240
+ # require "google/longrunning"
241
+ #
242
+ # # Create a client object. The client can be reused for multiple calls.
243
+ # client = Google::Longrunning::Operations::Rest::Client.new
244
+ #
245
+ # # Create a request. To set request fields, pass in keyword arguments.
246
+ # request = Google::Longrunning::GetOperationRequest.new
247
+ #
248
+ # # Call the get_operation method.
249
+ # result = client.get_operation request
250
+ #
251
+ # # The returned object is of type Gapic::Operation. You can use it to
252
+ # # check the status of an operation, cancel it, or wait for results.
253
+ # # Here is how to wait for a response.
254
+ # result.wait_until_done! timeout: 60
255
+ # if result.response?
256
+ # p result.response
257
+ # else
258
+ # puts "No response received."
259
+ # end
260
+ #
204
261
  def get_operation request, options = nil
205
262
  raise ::ArgumentError, "request must be provided" if request.nil?
206
263
 
@@ -267,6 +324,22 @@ module Google
267
324
  # @return [::Google::Protobuf::Empty]
268
325
  #
269
326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
327
+ #
328
+ # @example Basic example
329
+ # require "google/longrunning"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Longrunning::Operations::Rest::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Longrunning::DeleteOperationRequest.new
336
+ #
337
+ # # Call the delete_operation method.
338
+ # result = client.delete_operation request
339
+ #
340
+ # # The returned object is of type Google::Protobuf::Empty.
341
+ # p result
342
+ #
270
343
  def delete_operation request, options = nil
271
344
  raise ::ArgumentError, "request must be provided" if request.nil?
272
345
 
@@ -338,6 +411,22 @@ module Google
338
411
  # @return [::Google::Protobuf::Empty]
339
412
  #
340
413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
414
+ #
415
+ # @example Basic example
416
+ # require "google/longrunning"
417
+ #
418
+ # # Create a client object. The client can be reused for multiple calls.
419
+ # client = Google::Longrunning::Operations::Rest::Client.new
420
+ #
421
+ # # Create a request. To set request fields, pass in keyword arguments.
422
+ # request = Google::Longrunning::CancelOperationRequest.new
423
+ #
424
+ # # Call the cancel_operation method.
425
+ # result = client.cancel_operation request
426
+ #
427
+ # # The returned object is of type Google::Protobuf::Empty.
428
+ # p result
429
+ #
341
430
  def cancel_operation request, options = nil
342
431
  raise ::ArgumentError, "request must be provided" if request.nil?
343
432
 
@@ -403,9 +492,9 @@ module Google
403
492
  # end
404
493
  #
405
494
  # @!attribute [rw] endpoint
406
- # The hostname or hostname:port of the service endpoint.
407
- # Defaults to `"storagetransfer.googleapis.com"`.
408
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
409
498
  # @!attribute [rw] credentials
410
499
  # Credentials to send with calls. You may provide any of the following types:
411
500
  # * (`String`) The path to a service account key file in JSON format
@@ -442,13 +531,20 @@ module Google
442
531
  # @!attribute [rw] quota_project
443
532
  # A separate project against which to charge quota.
444
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
445
539
  #
446
540
  class Configuration
447
541
  extend ::Gapic::Config
448
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
449
545
  DEFAULT_ENDPOINT = "storagetransfer.googleapis.com"
450
546
 
451
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
452
548
  config_attr :credentials, nil do |value|
453
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
454
550
  allowed.any? { |klass| klass === value }
@@ -460,6 +556,7 @@ module Google
460
556
  config_attr :metadata, nil, ::Hash, nil
461
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
462
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
463
560
 
464
561
  # @private
465
562
  def initialize parent_config = nil
@@ -542,12 +639,15 @@ module Google
542
639
  # Service stub contains baseline method implementations
543
640
  # including transcoding, making the REST call, and deserialing the response.
544
641
  class OperationsServiceStub
545
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
546
643
  # These require statements are intentionally placed here to initialize
547
644
  # the REST modules only when it's required.
548
645
  require "gapic/rest"
549
646
 
550
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
551
651
  end
552
652
 
553
653
  ##
data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/service_stub.rb CHANGED
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the get_google_service_account REST call
45
57
  #
data/lib/google/cloud/storage_transfer/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module StorageTransfer
23
23
  module V1
24
- VERSION = "0.7.0"
24
+ VERSION = "0.9.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-storage_transfer-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-27 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
223
223
  - !ruby/object:Gem::Version
224
224
  version: '0'
225
225
  requirements: []
226
- rubygems_version: 3.4.2
226
+ rubygems_version: 3.5.3
227
227
  signing_key:
228
228
  specification_version: 4
229
229
  summary: Transfers data from external data sources to a Google Cloud Storage bucket