google-cloud-video-live_stream-v1 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/video/live_stream/v1/livestream_service/client.rb +43 -9
- data/lib/google/cloud/video/live_stream/v1/livestream_service/operations.rb +38 -7
- data/lib/google/cloud/video/live_stream/v1/livestream_service/rest/client.rb +480 -7
- data/lib/google/cloud/video/live_stream/v1/livestream_service/rest/operations.rb +108 -8
- data/lib/google/cloud/video/live_stream/v1/livestream_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/video/live_stream/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c77808c603774bf1587b71366b153693be28bb7da26b5cba0572cb8a0e817d52
|
4
|
+
data.tar.gz: 84bfcee9a7f3fd0822e272818ab6bb73f7b018139add40bf0a41785c7fdb4371
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b9f1885f148461327f21e44787271310064253df8b5652444c19ebfe967fd4abea64b71169a112f2ed8b40841e6260bd63ccccaac2740987f2d5e2daac2c7714
|
7
|
+
data.tar.gz: ffb147539f1075454c8141ffc59bea664a997cc9e3c0ba00ee2d7c1d42bfa42fcf1fd69282d734af9c5d7111e1ceb00c53157355e661595825d8922d9e967ad7
|
data/AUTHENTICATION.md
CHANGED
@@ -1,149 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
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-video-live_stream-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
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
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
|
-
|
28
|
-
|
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
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-cloud-video-live_stream-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
|
-
|
51
|
-
|
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
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
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-video-live_stream-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
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Cloud::Video::LiveStream::V1::LivestreamService::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
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
|
-
|
74
|
-
require "google/cloud/video/live_stream/v1"
|
75
|
-
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
77
43
|
|
78
|
-
client
|
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
|
-
|
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
|
-
|
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/video/live_stream/v1"
|
88
58
|
|
89
59
|
client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.new do |config|
|
90
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
91
61
|
end
|
92
62
|
```
|
93
63
|
|
94
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
95
65
|
|
96
66
|
```ruby
|
97
67
|
require "google/cloud/video/live_stream/v1"
|
98
68
|
|
99
69
|
::Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.configure do |config|
|
100
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
101
71
|
end
|
102
72
|
|
103
73
|
client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.new
|
104
74
|
```
|
105
75
|
|
106
|
-
###
|
76
|
+
### Environment Variables
|
107
77
|
|
108
|
-
|
109
|
-
|
110
|
-
|
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
|
-
|
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
|
-
|
115
|
-
|
116
|
-
|
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-video-live_stream-v1
|
93
|
+
checks for credentials are:
|
117
94
|
|
118
|
-
|
119
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
120
97
|
|
121
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/video/live_stream/v1"
|
122
100
|
|
123
|
-
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
125
|
-
connect to most services with google-cloud-video-live_stream-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
126
102
|
|
127
|
-
|
128
|
-
|
129
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::Video::LiveStream::V1::LivestreamService::Client.new
|
104
|
+
```
|
130
105
|
|
131
|
-
|
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
|
-
|
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
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
139
113
|
|
140
|
-
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
142
115
|
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
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
|
-
|
149
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -36,6 +36,9 @@ module Google
|
|
36
36
|
# Protocol (RTMP) and Secure Reliable Transport (SRT).
|
37
37
|
#
|
38
38
|
class Client
|
39
|
+
# @private
|
40
|
+
DEFAULT_ENDPOINT_TEMPLATE = "livestream.$UNIVERSE_DOMAIN$"
|
41
|
+
|
39
42
|
include Paths
|
40
43
|
|
41
44
|
# @private
|
@@ -146,6 +149,15 @@ module Google
|
|
146
149
|
@config
|
147
150
|
end
|
148
151
|
|
152
|
+
##
|
153
|
+
# The effective universe domain
|
154
|
+
#
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
def universe_domain
|
158
|
+
@livestream_service_stub.universe_domain
|
159
|
+
end
|
160
|
+
|
149
161
|
##
|
150
162
|
# Create a new LivestreamService client object.
|
151
163
|
#
|
@@ -179,8 +191,9 @@ module Google
|
|
179
191
|
credentials = @config.credentials
|
180
192
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
181
193
|
# but only if the default endpoint does not have a region prefix.
|
182
|
-
enable_self_signed_jwt = @config.endpoint
|
183
|
-
|
194
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
195
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
196
|
+
!@config.endpoint.split(".").first.include?("-"))
|
184
197
|
credentials ||= Credentials.default scope: @config.scope,
|
185
198
|
enable_self_signed_jwt: enable_self_signed_jwt
|
186
199
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -193,20 +206,25 @@ module Google
|
|
193
206
|
config.credentials = credentials
|
194
207
|
config.quota_project = @quota_project_id
|
195
208
|
config.endpoint = @config.endpoint
|
209
|
+
config.universe_domain = @config.universe_domain
|
196
210
|
end
|
197
211
|
|
198
212
|
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
199
213
|
config.credentials = credentials
|
200
214
|
config.quota_project = @quota_project_id
|
201
215
|
config.endpoint = @config.endpoint
|
216
|
+
config.universe_domain = @config.universe_domain
|
202
217
|
end
|
203
218
|
|
204
219
|
@livestream_service_stub = ::Gapic::ServiceStub.new(
|
205
220
|
::Google::Cloud::Video::LiveStream::V1::LivestreamService::Stub,
|
206
|
-
credentials:
|
207
|
-
endpoint:
|
221
|
+
credentials: credentials,
|
222
|
+
endpoint: @config.endpoint,
|
223
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
224
|
+
universe_domain: @config.universe_domain,
|
208
225
|
channel_args: @config.channel_args,
|
209
|
-
interceptors: @config.interceptors
|
226
|
+
interceptors: @config.interceptors,
|
227
|
+
channel_pool_config: @config.channel_pool
|
210
228
|
)
|
211
229
|
end
|
212
230
|
|
@@ -2558,9 +2576,9 @@ module Google
|
|
2558
2576
|
# end
|
2559
2577
|
#
|
2560
2578
|
# @!attribute [rw] endpoint
|
2561
|
-
#
|
2562
|
-
#
|
2563
|
-
# @return [::String]
|
2579
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
2580
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
2581
|
+
# @return [::String,nil]
|
2564
2582
|
# @!attribute [rw] credentials
|
2565
2583
|
# Credentials to send with calls. You may provide any of the following types:
|
2566
2584
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -2606,13 +2624,20 @@ module Google
|
|
2606
2624
|
# @!attribute [rw] quota_project
|
2607
2625
|
# A separate project against which to charge quota.
|
2608
2626
|
# @return [::String]
|
2627
|
+
# @!attribute [rw] universe_domain
|
2628
|
+
# The universe domain within which to make requests. This determines the
|
2629
|
+
# default endpoint URL. The default value of nil uses the environment
|
2630
|
+
# universe (usually the default "googleapis.com" universe).
|
2631
|
+
# @return [::String,nil]
|
2609
2632
|
#
|
2610
2633
|
class Configuration
|
2611
2634
|
extend ::Gapic::Config
|
2612
2635
|
|
2636
|
+
# @private
|
2637
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
2613
2638
|
DEFAULT_ENDPOINT = "livestream.googleapis.com"
|
2614
2639
|
|
2615
|
-
config_attr :endpoint,
|
2640
|
+
config_attr :endpoint, nil, ::String, nil
|
2616
2641
|
config_attr :credentials, nil do |value|
|
2617
2642
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2618
2643
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -2627,6 +2652,7 @@ module Google
|
|
2627
2652
|
config_attr :metadata, nil, ::Hash, nil
|
2628
2653
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2629
2654
|
config_attr :quota_project, nil, ::String, nil
|
2655
|
+
config_attr :universe_domain, nil, ::String, nil
|
2630
2656
|
|
2631
2657
|
# @private
|
2632
2658
|
def initialize parent_config = nil
|
@@ -2647,6 +2673,14 @@ module Google
|
|
2647
2673
|
end
|
2648
2674
|
end
|
2649
2675
|
|
2676
|
+
##
|
2677
|
+
# Configuration for the channel pool
|
2678
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
2679
|
+
#
|
2680
|
+
def channel_pool
|
2681
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
2682
|
+
end
|
2683
|
+
|
2650
2684
|
##
|
2651
2685
|
# Configuration RPC class for the LivestreamService API.
|
2652
2686
|
#
|
@@ -27,6 +27,9 @@ module Google
|
|
27
27
|
module LivestreamService
|
28
28
|
# Service that implements Longrunning Operations API.
|
29
29
|
class Operations
|
30
|
+
# @private
|
31
|
+
DEFAULT_ENDPOINT_TEMPLATE = "livestream.$UNIVERSE_DOMAIN$"
|
32
|
+
|
30
33
|
# @private
|
31
34
|
attr_reader :operations_stub
|
32
35
|
|
@@ -61,6 +64,15 @@ module Google
|
|
61
64
|
@config
|
62
65
|
end
|
63
66
|
|
67
|
+
##
|
68
|
+
# The effective universe domain
|
69
|
+
#
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
def universe_domain
|
73
|
+
@operations_stub.universe_domain
|
74
|
+
end
|
75
|
+
|
64
76
|
##
|
65
77
|
# Create a new Operations client object.
|
66
78
|
#
|
@@ -91,10 +103,13 @@ module Google
|
|
91
103
|
|
92
104
|
@operations_stub = ::Gapic::ServiceStub.new(
|
93
105
|
::Google::Longrunning::Operations::Stub,
|
94
|
-
credentials:
|
95
|
-
endpoint:
|
106
|
+
credentials: credentials,
|
107
|
+
endpoint: @config.endpoint,
|
108
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
109
|
+
universe_domain: @config.universe_domain,
|
96
110
|
channel_args: @config.channel_args,
|
97
|
-
interceptors: @config.interceptors
|
111
|
+
interceptors: @config.interceptors,
|
112
|
+
channel_pool_config: @config.channel_pool
|
98
113
|
)
|
99
114
|
|
100
115
|
# Used by an LRO wrapper for some methods of this service
|
@@ -613,9 +628,9 @@ module Google
|
|
613
628
|
# end
|
614
629
|
#
|
615
630
|
# @!attribute [rw] endpoint
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# @return [::String]
|
631
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
632
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
633
|
+
# @return [::String,nil]
|
619
634
|
# @!attribute [rw] credentials
|
620
635
|
# Credentials to send with calls. You may provide any of the following types:
|
621
636
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -661,13 +676,20 @@ module Google
|
|
661
676
|
# @!attribute [rw] quota_project
|
662
677
|
# A separate project against which to charge quota.
|
663
678
|
# @return [::String]
|
679
|
+
# @!attribute [rw] universe_domain
|
680
|
+
# The universe domain within which to make requests. This determines the
|
681
|
+
# default endpoint URL. The default value of nil uses the environment
|
682
|
+
# universe (usually the default "googleapis.com" universe).
|
683
|
+
# @return [::String,nil]
|
664
684
|
#
|
665
685
|
class Configuration
|
666
686
|
extend ::Gapic::Config
|
667
687
|
|
688
|
+
# @private
|
689
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
668
690
|
DEFAULT_ENDPOINT = "livestream.googleapis.com"
|
669
691
|
|
670
|
-
config_attr :endpoint,
|
692
|
+
config_attr :endpoint, nil, ::String, nil
|
671
693
|
config_attr :credentials, nil do |value|
|
672
694
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
673
695
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -682,6 +704,7 @@ module Google
|
|
682
704
|
config_attr :metadata, nil, ::Hash, nil
|
683
705
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
684
706
|
config_attr :quota_project, nil, ::String, nil
|
707
|
+
config_attr :universe_domain, nil, ::String, nil
|
685
708
|
|
686
709
|
# @private
|
687
710
|
def initialize parent_config = nil
|
@@ -702,6 +725,14 @@ module Google
|
|
702
725
|
end
|
703
726
|
end
|
704
727
|
|
728
|
+
##
|
729
|
+
# Configuration for the channel pool
|
730
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
731
|
+
#
|
732
|
+
def channel_pool
|
733
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
734
|
+
end
|
735
|
+
|
705
736
|
##
|
706
737
|
# Configuration RPC class for the Operations API.
|
707
738
|
#
|