google-cloud-alloy_db-v1 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/client.rb +2693 -0
  6. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/credentials.rb +47 -0
  7. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/operations.rb +768 -0
  8. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/paths.rb +149 -0
  9. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest/client.rb +2111 -0
  10. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest/operations.rb +793 -0
  11. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest/service_stub.rb +1238 -0
  12. data/lib/google/cloud/alloy_db/v1/alloy_db_admin/rest.rb +54 -0
  13. data/lib/google/cloud/alloy_db/v1/alloy_db_admin.rb +56 -0
  14. data/lib/google/cloud/alloy_db/v1/bindings_override.rb +102 -0
  15. data/lib/google/cloud/alloy_db/v1/rest.rb +38 -0
  16. data/lib/google/cloud/alloy_db/v1/version.rb +8 -3
  17. data/lib/google/cloud/alloy_db/v1.rb +45 -0
  18. data/lib/google/cloud/alloydb/v1/resources_pb.rb +312 -0
  19. data/lib/google/cloud/alloydb/v1/service_pb.rb +237 -0
  20. data/lib/google/cloud/alloydb/v1/service_services_pb.rb +97 -0
  21. data/lib/google-cloud-alloy_db-v1.rb +21 -0
  22. data/proto_docs/README.md +4 -0
  23. data/proto_docs/google/api/client.rb +324 -0
  24. data/proto_docs/google/api/field_behavior.rb +71 -0
  25. data/proto_docs/google/api/launch_stage.rb +71 -0
  26. data/proto_docs/google/api/resource.rb +222 -0
  27. data/proto_docs/google/cloud/alloydb/v1/resources.rb +985 -0
  28. data/proto_docs/google/cloud/alloydb/v1/service.rb +815 -0
  29. data/proto_docs/google/longrunning/operations.rb +164 -0
  30. data/proto_docs/google/protobuf/any.rb +141 -0
  31. data/proto_docs/google/protobuf/duration.rb +98 -0
  32. data/proto_docs/google/protobuf/empty.rb +34 -0
  33. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  34. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  35. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  36. data/proto_docs/google/rpc/status.rb +48 -0
  37. data/proto_docs/google/type/dayofweek.rb +49 -0
  38. data/proto_docs/google/type/expr.rb +75 -0
  39. data/proto_docs/google/type/timeofday.rb +45 -0
  40. metadata +250 -12
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 79d0e3fd4c90ebe8bbb24db63b146584814167d093d85f99ec88195b27a86680
4
- data.tar.gz: cf183428a6fb65c7c095b8b2daeac9576f7fa541d53f6c21a8964fa5c093828f
3
+ metadata.gz: 26ff307354c374d75a4a6c29b1c1fbf68101740e051da5a2458892bf3a8d741d
4
+ data.tar.gz: d76dd2d7048f4d67d6cd3d91d8b8c35300fad76945e57b25a2d15ff35de0c149
5
5
  SHA512:
6
- metadata.gz: 48e2f339b4b5408976ab0719b32d0f28e1dcb471eb506ce889fc41b560ff3280ab8c16f34eeb12857e40714d1a5bd29e162ac3e28a050a31cd50a2078838bf3c
7
- data.tar.gz: 4d2daa765724a810a7926200e49cc96e88c862710c497dfc9d1b09456a1f0dbc92afa4b4dd4d3d961ca2c52f71872a75fc0a6cdb8259273410ad3af99a81d5bf
6
+ metadata.gz: 7731ae049f598a11378527fc1fa99c7c7431ee8cca4581ecfe432d9e1416521f3a80e474b16f3fce2a328d6a6c1d8b57151e41a91f9cfdccc03062e7a1b43f4b
7
+ data.tar.gz: 4efe0e2c10fbbb962c67042e0efe55031dc077bdc71f229618ea98ae75debbc262478873399c9b4d08820016063da54261afaedefcf1bddfd90518cba5ee6ab1
data/.yardopts ADDED
@@ -0,0 +1,12 @@
1
+ --no-private
2
+ --title="AlloyDB V1 API"
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ ./proto_docs/**/*.rb
9
+ -
10
+ README.md
11
+ LICENSE.md
12
+ AUTHENTICATION.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,149 @@
1
+ # Authentication
2
+
3
+ In general, the google-cloud-alloy_db-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.
15
+
16
+ ## Quickstart
17
+
18
+ 1. [Create a service account and credentials](#creating-a-service-account).
19
+ 2. Set the [environment variable](#environment-variables).
20
+
21
+ ```sh
22
+ export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
23
+ ```
24
+
25
+ 3. Initialize the client.
26
+
27
+ ```ruby
28
+ require "google/cloud/alloy_db/v1"
29
+
30
+ client = ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
31
+ ```
32
+
33
+ ## Credential Lookup
34
+
35
+ The google-cloud-alloy_db-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
49
+
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.
54
+
55
+ ### Environment Variables
56
+
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.
64
+
65
+ The environment variables that google-cloud-alloy_db-v1
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ {::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Credentials}):
68
+
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
72
+
73
+ ```ruby
74
+ require "google/cloud/alloy_db/v1"
75
+
76
+ ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
77
+
78
+ client = ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
79
+ ```
80
+
81
+ ### Configuration
82
+
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:
85
+
86
+ ```ruby
87
+ require "google/cloud/alloy_db/v1"
88
+
89
+ client = ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new do |config|
90
+ config.credentials = "path/to/keyfile.json"
91
+ end
92
+ ```
93
+
94
+ Or globally for all clients:
95
+
96
+ ```ruby
97
+ require "google/cloud/alloy_db/v1"
98
+
99
+ ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.configure do |config|
100
+ config.credentials = "path/to/keyfile.json"
101
+ end
102
+
103
+ client = ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
104
+ ```
105
+
106
+ ### Cloud SDK
107
+
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.
111
+
112
+ To configure your system for this, simply:
113
+
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.
117
+
118
+ **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
+ *should* only be used during development.
120
+
121
+ ## Creating a Service Account
122
+
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-alloy_db-v1.
126
+
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.
130
+
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.
135
+
136
+ *Note: You may need to enable billing in order to use these services.*
137
+
138
+ 4. Select **Credentials** from the side navigation.
139
+
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.
142
+
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**.
147
+
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.
data/README.md CHANGED
@@ -1,8 +1,144 @@
1
- # Placeholder for Ruby gem google-cloud-alloy_db-v1
2
-
3
- This is a placeholder for the future Google-authored gem google-cloud-alloy_db-v1.
4
- This placeholder is being released on 2023-03-20 in order to reserve the name.
5
- The final gem should be available shortly after that date. If it has not been
6
- released in a timely manner, or if this placeholder interferes with your work,
7
- you can contact the Google Ruby team by opening an issue in the GitHub
8
- repository https://github.com/googleapis/google-cloud-ruby.
1
+ # Ruby Client for the AlloyDB V1 API
2
+
3
+ AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
4
+
5
+ AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
6
+
7
+ https://github.com/googleapis/google-cloud-ruby
8
+
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the AlloyDB V1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-alloy_db](https://rubygems.org/gems/google-cloud-alloy_db).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
15
+ ## Installation
16
+
17
+ ```
18
+ $ gem install google-cloud-alloy_db-v1
19
+ ```
20
+
21
+ ## Before You Begin
22
+
23
+ In order to use this library, you first need to go through the following steps:
24
+
25
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
26
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
27
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/alloydb.googleapis.com)
28
+ 1. {file:AUTHENTICATION.md Set up authentication.}
29
+
30
+ ## Quick Start
31
+
32
+ ```ruby
33
+ require "google/cloud/alloy_db/v1"
34
+
35
+ client = ::Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
36
+ request = ::Google::Cloud::AlloyDB::V1::ListClustersRequest.new # (request fields as keyword arguments...)
37
+ response = client.list_clusters request
38
+ ```
39
+
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-alloy_db-v1/latest)
41
+ for class and method documentation.
42
+
43
+ See also the [Product Documentation](https://cloud.google.com/alloydb/docs)
44
+ for general usage information.
45
+
46
+ ## Enabling Logging
47
+
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/current/stdlibs/logger/Logger.html) as shown below,
50
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
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
+ and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
+
54
+ Configuring a Ruby stdlib logger:
55
+
56
+ ```ruby
57
+ require "logger"
58
+
59
+ module MyLogger
60
+ LOGGER = Logger.new $stderr, level: Logger::WARN
61
+ def logger
62
+ LOGGER
63
+ end
64
+ end
65
+
66
+ # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
+ module GRPC
68
+ extend MyLogger
69
+ end
70
+ ```
71
+
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
77
+ ## Supported Ruby Versions
78
+
79
+ This library is supported on Ruby 2.6+.
80
+
81
+ Google provides official support for Ruby versions that are actively supported
82
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
87
+
88
+ ## Which client should I use?
89
+
90
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
91
+ client library with a name such as `google-cloud-alloy_db`,
92
+ and lower-level _versioned_ client libraries with names such as
93
+ `google-cloud-alloy_db-v1`.
94
+ _In most cases, you should install the main client._
95
+
96
+ ### What's the difference between the main client and a versioned client?
97
+
98
+ A _versioned client_ provides a basic set of data types and client classes for
99
+ a _single version_ of a specific service. (That is, for a service with multiple
100
+ versions, there might be a separate versioned client for each service version.)
101
+ Most versioned clients are written and maintained by a code generator.
102
+
103
+ The _main client_ is designed to provide you with the _recommended_ client
104
+ interfaces for the service. There will be only one main client for any given
105
+ service, even a service with multiple versions. The main client includes
106
+ factory methods for constructing the client objects we recommend for most
107
+ users. In some cases, those will be classes provided by an underlying versioned
108
+ client; in other cases, they will be handwritten higher-level client objects
109
+ with additional capabilities, convenience methods, or best practices built in.
110
+ Generally, the main client will default to a recommended service version,
111
+ although in some cases you can override this if you need to talk to a specific
112
+ service version.
113
+
114
+ ### Why would I want to use the main client?
115
+
116
+ We recommend that most users install the main client gem for a service. You can
117
+ identify this gem as the one _without_ a version in its name, e.g.
118
+ `google-cloud-alloy_db`.
119
+ The main client is recommended because it will embody the best practices for
120
+ accessing the service, and may also provide more convenient interfaces or
121
+ tighter integration into frameworks and third-party libraries. In addition, the
122
+ documentation and samples published by Google will generally demonstrate use of
123
+ the main client.
124
+
125
+ ### Why would I want to use a versioned client?
126
+
127
+ You can use a versioned client if you are content with a possibly lower-level
128
+ class interface, you explicitly want to avoid features provided by the main
129
+ client, or you want to access a specific service version not be covered by the
130
+ main client. You can identify versioned client gems because the service version
131
+ is part of the name, e.g. `google-cloud-alloy_db-v1`.
132
+
133
+ ### What about the google-apis-<name> clients?
134
+
135
+ Client library gems with names that begin with `google-apis-` are based on an
136
+ older code generation technology. They talk to a REST/JSON backend (whereas
137
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
138
+ not offer the same performance, features, and ease of use provided by more
139
+ modern clients.
140
+
141
+ The `google-apis-` clients have wide coverage across Google services, so you
142
+ might need to use one if there is no modern client available for the service.
143
+ However, if a modern client is available, we generally recommend it over the
144
+ older `google-apis-` clients.