google-cloud-bigquery-connection-v1 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c21f2576f05bbd9ddcb01bdbace0e68c3e3eb005bc62d868a0166b25bb0d3baf
-  data.tar.gz: d01dcaa26bea20dca75ec37bf824e73db468669b061ae075fde9f68e59f04e2a
+  metadata.gz: e03a785f26dd6f2e64e6a34f2522a6af24c5a54f3b18012ac760172d4b008436
+  data.tar.gz: 9e34b00fefde01dd29eac3c350a1975be112b033296e3a8e11b4132f96563b9a
 SHA512:
-  metadata.gz: 4318a322d7b8860286b2c280b1c4f14f81433de4d9144a6e41a14246f767dcead2d00630fcf6390b37a396cddeb2a4643b7f680c181956069682f58fd616bb5d
-  data.tar.gz: 423da136360d1ebf6f447755c729929ecbc27832c73ef0a14673437dc957dbbf3c86d4e44e6a517358afd5c94086ac5fc8dcb5706faae43244762c7e66cf5e9c
+  metadata.gz: 2dec692352fa2bfee38ece5f4d1146e76d514947242a9ca240f23c2d44f974574e6640ed5ac385a351cb924db58665c08dbc10db7ef0f8f8d0049f8bcd9fefcb
+  data.tar.gz: 38e5b3a4eca36977f7257ef364303322ca76a3d86055d1a2877d725a16b2b9f1dc76a678a66ae04cfcd6598f34b75d90bcc8e9c0e33e9af3d6c5750a99e619a3

data/README.md

@@ -6,6 +6,12 @@ The BigQuery Connection API allows users to manage BigQuery connections to exter
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the BigQuery Connection V1 API. Most users should consider using
+the main client gem,
+[google-cloud-bigquery-connection](https://rubygems.org/gems/google-cloud-bigquery-connection).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-bigquery-connection`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-bigquery-connection-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-bigquery-connection`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-bigquery-connection-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/cloud/bigquery/connection/v1.rb

@@ -35,3 +35,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v1", "_helpers.rb"
+require "google/cloud/bigquery/connection/v1/_helpers" if ::File.file? helper_path

data/lib/google/cloud/bigquery/connection/v1/connection_pb.rb

@@ -48,6 +48,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :has_credential, :bool, 7
       oneof :properties do
         optional :cloud_sql, :message, 4, "google.cloud.bigquery.connection.v1.CloudSqlProperties"
+        optional :aws, :message, 8, "google.cloud.bigquery.connection.v1.AwsProperties"
       end
     end
     add_message "google.cloud.bigquery.connection.v1.CloudSqlProperties" do
@@ -65,6 +66,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :username, :string, 1
       optional :password, :string, 2
     end
+    add_message "google.cloud.bigquery.connection.v1.AwsProperties" do
+      oneof :authentication_method do
+        optional :cross_account_role, :message, 2, "google.cloud.bigquery.connection.v1.AwsCrossAccountRole"
+      end
+    end
+    add_message "google.cloud.bigquery.connection.v1.AwsCrossAccountRole" do
+      optional :iam_role_id, :string, 1
+      optional :iam_user_id, :string, 2
+      optional :external_id, :string, 3
+    end
   end
 end
 
@@ -83,6 +94,8 @@ module Google
           CloudSqlProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.connection.v1.CloudSqlProperties").msgclass
           CloudSqlProperties::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.connection.v1.CloudSqlProperties.DatabaseType").enummodule
           CloudSqlCredential = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.connection.v1.CloudSqlCredential").msgclass
+          AwsProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.connection.v1.AwsProperties").msgclass
+          AwsCrossAccountRole = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.bigquery.connection.v1.AwsCrossAccountRole").msgclass
         end
       end
     end

data/lib/google/cloud/bigquery/connection/v1/connection_service/client.rb

@@ -73,7 +73,7 @@ module Google
                     initial_delay: 0.1,
                     max_delay:     60.0,
                     multiplier:    1.3,
-                    retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                    retry_codes:   [4, 14]
                   }
 
                   default_config.rpcs.list_connections.timeout = 60.0
@@ -81,7 +81,7 @@ module Google
                     initial_delay: 0.1,
                     max_delay:     60.0,
                     multiplier:    1.3,
-                    retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                    retry_codes:   [4, 14]
                   }
 
                   default_config.rpcs.update_connection.timeout = 60.0
@@ -91,7 +91,7 @@ module Google
                     initial_delay: 0.1,
                     max_delay:     60.0,
                     multiplier:    1.3,
-                    retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                    retry_codes:   [4, 14]
                   }
 
                   default_config.rpcs.get_iam_policy.timeout = 60.0
@@ -161,7 +161,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                credentials ||= Credentials.default scope: @config.scope
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope:                  @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(String) || credentials.is_a?(Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end
@@ -838,7 +844,7 @@ module Google
 
                 config_attr :endpoint,      "bigqueryconnection.googleapis.com", ::String
                 config_attr :credentials,   nil do |value|
-                  allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                   allowed.any? { |klass| klass === value }
                 end
@@ -878,7 +884,7 @@ module Google
                 # Each configuration object is of type `Gapic::Config::Method` and includes
                 # the following configuration fields:
                 #
-                #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
                 #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
                 #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
                 #     include the following keys:

data/lib/google/cloud/bigquery/connection/v1/connection_services_pb.rb

@@ -35,25 +35,25 @@ module Google
               self.service_name = 'google.cloud.bigquery.connection.v1.ConnectionService'
 
               # Creates a new connection.
-              rpc :CreateConnection, CreateConnectionRequest, Connection
+              rpc :CreateConnection, ::Google::Cloud::Bigquery::Connection::V1::CreateConnectionRequest, ::Google::Cloud::Bigquery::Connection::V1::Connection
               # Returns specified connection.
-              rpc :GetConnection, GetConnectionRequest, Connection
+              rpc :GetConnection, ::Google::Cloud::Bigquery::Connection::V1::GetConnectionRequest, ::Google::Cloud::Bigquery::Connection::V1::Connection
               # Returns a list of connections in the given project.
-              rpc :ListConnections, ListConnectionsRequest, ListConnectionsResponse
+              rpc :ListConnections, ::Google::Cloud::Bigquery::Connection::V1::ListConnectionsRequest, ::Google::Cloud::Bigquery::Connection::V1::ListConnectionsResponse
               # Updates the specified connection. For security reasons, also resets
               # credential if connection properties are in the update field mask.
-              rpc :UpdateConnection, UpdateConnectionRequest, Connection
+              rpc :UpdateConnection, ::Google::Cloud::Bigquery::Connection::V1::UpdateConnectionRequest, ::Google::Cloud::Bigquery::Connection::V1::Connection
               # Deletes connection and associated credential.
-              rpc :DeleteConnection, DeleteConnectionRequest, Google::Protobuf::Empty
+              rpc :DeleteConnection, ::Google::Cloud::Bigquery::Connection::V1::DeleteConnectionRequest, ::Google::Protobuf::Empty
               # Gets the access control policy for a resource.
               # Returns an empty policy if the resource exists and does not have a policy
               # set.
-              rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
+              rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
               # Sets the access control policy on the specified resource. Replaces any
               # existing policy.
               #
               # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
-              rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
+              rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
               # Returns permissions that a caller has on the specified resource.
               # If the resource does not exist, this will return an empty set of
               # permissions, not a `NOT_FOUND` error.
@@ -61,7 +61,7 @@ module Google
               # Note: This operation is designed to be used for building permission-aware
               # UIs and command-line tools, not for authorization checking. This operation
               # may "fail open" without warning.
-              rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
+              rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
             end
 
             Stub = Service.rpc_stub_class

data/lib/google/cloud/bigquery/connection/v1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Bigquery
       module Connection
         module V1
-          VERSION = "0.1.0"
+          VERSION = "0.3.0"
         end
       end
     end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/bigquery/connection/v1/connection.rb

@@ -117,6 +117,9 @@ module Google
           # @!attribute [rw] cloud_sql
           #   @return [::Google::Cloud::Bigquery::Connection::V1::CloudSqlProperties]
           #     Cloud SQL properties.
+          # @!attribute [rw] aws
+          #   @return [::Google::Cloud::Bigquery::Connection::V1::AwsProperties]
+          #     Amazon Web Services (AWS) properties.
           # @!attribute [r] creation_time
           #   @return [::Integer]
           #     Output only. The creation timestamp of the connection.
@@ -172,6 +175,35 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Connection properties specific to Amazon Web Services (AWS).
+          # @!attribute [rw] cross_account_role
+          #   @return [::Google::Cloud::Bigquery::Connection::V1::AwsCrossAccountRole]
+          #     Authentication using Google owned AWS IAM user's access key to assume
+          #     into customer's AWS IAM Role.
+          class AwsProperties
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Authentication method for Amazon Web Services (AWS) that uses Google owned
+          # AWS IAM user's access key to assume into customer's AWS IAM Role.
+          # @!attribute [rw] iam_role_id
+          #   @return [::String]
+          #     The user’s AWS IAM Role that trusts the Google-owned AWS IAM user
+          #     Connection.
+          # @!attribute [r] iam_user_id
+          #   @return [::String]
+          #     Output only. Google-owned AWS IAM User for a Connection.
+          # @!attribute [r] external_id
+          #   @return [::String]
+          #     Output only. A Google-generated id for representing Connection’s identity in AWS.
+          #     External Id is also used for preventing the Confused Deputy Problem. See
+          #     https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
+          class AwsCrossAccountRole
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery-connection-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -171,7 +171,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: The BigQuery Connection API allows users to manage BigQuery connections
-  to external data sources.
+  to external data sources. Note that google-cloud-bigquery-connection-v1 is a version-specific
+  client library. For most uses, we recommend installing the main client library google-cloud-bigquery-connection
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -220,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the BigQuery Connection V1 API