google-cloud-os_login 0.1.0

data/lib/google/cloud/os_login/v1beta/os_login_service_client.rb

@@ -0,0 +1,429 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/cloud/oslogin/v1beta/oslogin.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+#
+# The only allowed edits are to method and file documentation. A 3-way
+# merge preserves those additions if the generated source changes.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+
+require "google/cloud/oslogin/v1beta/oslogin_pb"
+require "google/cloud/os_login/credentials"
+
+module Google
+  module Cloud
+    module OsLogin
+      module V1beta
+        # Cloud OS Login API
+        #
+        # The Cloud OS Login API allows you to manage users and their associated SSH
+        # public keys for logging into virtual machines on Google Cloud Platform.
+        #
+        # @!attribute [r] os_login_service_stub
+        #   @return [Google::Cloud::Oslogin::V1beta::OsLoginService::Stub]
+        class OsLoginServiceClient
+          attr_reader :os_login_service_stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "oslogin.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          DEFAULT_TIMEOUT = 30
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_SCOPES = [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/cloud-platform.read-only",
+            "https://www.googleapis.com/auth/compute",
+            "https://www.googleapis.com/auth/compute.readonly"
+          ].freeze
+
+
+          USER_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "users/{user}"
+          )
+
+          private_constant :USER_PATH_TEMPLATE
+
+          PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "users/{user}/projects/{project}"
+          )
+
+          private_constant :PROJECT_PATH_TEMPLATE
+
+          FINGERPRINT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "users/{user}/sshPublicKeys/{fingerprint}"
+          )
+
+          private_constant :FINGERPRINT_PATH_TEMPLATE
+
+          # Returns a fully-qualified user resource name string.
+          # @param user [String]
+          # @return [String]
+          def self.user_path user
+            USER_PATH_TEMPLATE.render(
+              :"user" => user
+            )
+          end
+
+          # Returns a fully-qualified project resource name string.
+          # @param user [String]
+          # @param project [String]
+          # @return [String]
+          def self.project_path user, project
+            PROJECT_PATH_TEMPLATE.render(
+              :"user" => user,
+              :"project" => project
+            )
+          end
+
+          # Returns a fully-qualified fingerprint resource name string.
+          # @param user [String]
+          # @param fingerprint [String]
+          # @return [String]
+          def self.fingerprint_path user, fingerprint
+            FINGERPRINT_PATH_TEMPLATE.render(
+              :"user" => user,
+              :"fingerprint" => fingerprint
+            )
+          end
+
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          def initialize \
+              credentials: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              lib_name: nil,
+              lib_version: ""
+            # These require statements are intentionally placed here to initialize
+            # the gRPC module only when it's required.
+            # See https://github.com/googleapis/toolkit/issues/446
+            require "google/gax/grpc"
+            require "google/cloud/oslogin/v1beta/oslogin_services_pb"
+
+            credentials ||= Google::Cloud::OsLogin::Credentials.default
+
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::OsLogin::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
+            end
+
+            package_version = Gem.loaded_specs['google-cloud-os_login'].version.version
+
+            google_api_client = "gl-ruby/#{RUBY_VERSION}"
+            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+            google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+            google_api_client << " grpc/#{GRPC::VERSION}"
+            google_api_client.freeze
+
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "os_login_service_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.cloud.oslogin.v1beta.OsLoginService",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+
+            # Allow overriding the service path/port in subclasses.
+            service_path = self.class::SERVICE_ADDRESS
+            port = self.class::DEFAULT_SERVICE_PORT
+            @os_login_service_stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              updater_proc: updater_proc,
+              scopes: scopes,
+              &Google::Cloud::Oslogin::V1beta::OsLoginService::Stub.method(:new)
+            )
+
+            @delete_posix_account = Google::Gax.create_api_call(
+              @os_login_service_stub.method(:delete_posix_account),
+              defaults["delete_posix_account"]
+            )
+            @delete_ssh_public_key = Google::Gax.create_api_call(
+              @os_login_service_stub.method(:delete_ssh_public_key),
+              defaults["delete_ssh_public_key"]
+            )
+            @get_login_profile = Google::Gax.create_api_call(
+              @os_login_service_stub.method(:get_login_profile),
+              defaults["get_login_profile"]
+            )
+            @get_ssh_public_key = Google::Gax.create_api_call(
+              @os_login_service_stub.method(:get_ssh_public_key),
+              defaults["get_ssh_public_key"]
+            )
+            @import_ssh_public_key = Google::Gax.create_api_call(
+              @os_login_service_stub.method(:import_ssh_public_key),
+              defaults["import_ssh_public_key"]
+            )
+            @update_ssh_public_key = Google::Gax.create_api_call(
+              @os_login_service_stub.method(:update_ssh_public_key),
+              defaults["update_ssh_public_key"]
+            )
+          end
+
+          # Service calls
+
+          # Deletes a POSIX account.
+          #
+          # @param name [String]
+          #   A reference to the POSIX account to update. POSIX accounts are identified
+          #   by the project ID they are associated with. A reference to the POSIX
+          #   account is in format +users/{user}/projects/{project}+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/os_login/v1beta"
+          #
+          #   os_login_service_client = Google::Cloud::OsLogin::V1beta.new
+          #   formatted_name = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.project_path("[USER]", "[PROJECT]")
+          #   os_login_service_client.delete_posix_account(formatted_name)
+
+          def delete_posix_account \
+              name,
+              options: nil
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1beta::DeletePosixAccountRequest)
+            @delete_posix_account.call(req, options)
+            nil
+          end
+
+          # Deletes an SSH public key.
+          #
+          # @param name [String]
+          #   The fingerprint of the public key to update. Public keys are identified by
+          #   their SHA-256 fingerprint. The fingerprint of the public key is in format
+          #   +users/{user}/sshPublicKeys/{fingerprint}+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/os_login/v1beta"
+          #
+          #   os_login_service_client = Google::Cloud::OsLogin::V1beta.new
+          #   formatted_name = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
+          #   os_login_service_client.delete_ssh_public_key(formatted_name)
+
+          def delete_ssh_public_key \
+              name,
+              options: nil
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1beta::DeleteSshPublicKeyRequest)
+            @delete_ssh_public_key.call(req, options)
+            nil
+          end
+
+          # Retrieves the profile information used for logging in to a virtual machine
+          # on Google Compute Engine.
+          #
+          # @param name [String]
+          #   The unique ID for the user in format +users/{user}+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Oslogin::V1beta::LoginProfile]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/os_login/v1beta"
+          #
+          #   os_login_service_client = Google::Cloud::OsLogin::V1beta.new
+          #   formatted_name = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.user_path("[USER]")
+          #   response = os_login_service_client.get_login_profile(formatted_name)
+
+          def get_login_profile \
+              name,
+              options: nil
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1beta::GetLoginProfileRequest)
+            @get_login_profile.call(req, options)
+          end
+
+          # Retrieves an SSH public key.
+          #
+          # @param name [String]
+          #   The fingerprint of the public key to retrieve. Public keys are identified
+          #   by their SHA-256 fingerprint. The fingerprint of the public key is in
+          #   format +users/{user}/sshPublicKeys/{fingerprint}+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/os_login/v1beta"
+          #
+          #   os_login_service_client = Google::Cloud::OsLogin::V1beta.new
+          #   formatted_name = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
+          #   response = os_login_service_client.get_ssh_public_key(formatted_name)
+
+          def get_ssh_public_key \
+              name,
+              options: nil
+            req = {
+              name: name
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1beta::GetSshPublicKeyRequest)
+            @get_ssh_public_key.call(req, options)
+          end
+
+          # Adds an SSH public key and returns the profile information. Default POSIX
+          # account information is set when no username and UID exist as part of the
+          # login profile.
+          #
+          # @param parent [String]
+          #   The unique ID for the user in format +users/{user}+.
+          # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
+          #   The SSH public key and expiration time.
+          #   A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
+          #   can also be provided.
+          # @param project_id [String]
+          #   The project ID of the Google Cloud Platform project.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Oslogin::V1beta::ImportSshPublicKeyResponse]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/os_login/v1beta"
+          #
+          #   os_login_service_client = Google::Cloud::OsLogin::V1beta.new
+          #   formatted_parent = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.user_path("[USER]")
+          #   ssh_public_key = {}
+          #   response = os_login_service_client.import_ssh_public_key(formatted_parent, ssh_public_key)
+
+          def import_ssh_public_key \
+              parent,
+              ssh_public_key,
+              project_id: nil,
+              options: nil
+            req = {
+              parent: parent,
+              ssh_public_key: ssh_public_key,
+              project_id: project_id
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1beta::ImportSshPublicKeyRequest)
+            @import_ssh_public_key.call(req, options)
+          end
+
+          # Updates an SSH public key and returns the profile information. This method
+          # supports patch semantics.
+          #
+          # @param name [String]
+          #   The fingerprint of the public key to update. Public keys are identified by
+          #   their SHA-256 fingerprint. The fingerprint of the public key is in format
+          #   +users/{user}/sshPublicKeys/{fingerprint}+.
+          # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
+          #   The SSH public key and expiration time.
+          #   A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
+          #   can also be provided.
+          # @param update_mask [Google::Protobuf::FieldMask | Hash]
+          #   Mask to control which fields get updated. Updates all if not present.
+          #   A hash of the same form as `Google::Protobuf::FieldMask`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/os_login/v1beta"
+          #
+          #   os_login_service_client = Google::Cloud::OsLogin::V1beta.new
+          #   formatted_name = Google::Cloud::OsLogin::V1beta::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
+          #   ssh_public_key = {}
+          #   response = os_login_service_client.update_ssh_public_key(formatted_name, ssh_public_key)
+
+          def update_ssh_public_key \
+              name,
+              ssh_public_key,
+              update_mask: nil,
+              options: nil
+            req = {
+              name: name,
+              ssh_public_key: ssh_public_key,
+              update_mask: update_mask
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1beta::UpdateSshPublicKeyRequest)
+            @update_ssh_public_key.call(req, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/os_login/v1beta/os_login_service_client_config.json

@@ -0,0 +1,56 @@
+{
+  "interfaces": {
+    "google.cloud.oslogin.v1beta.OsLoginService": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": []
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 60000,
+          "initial_rpc_timeout_millis": 10000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 10000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "DeletePosixAccount": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteSshPublicKey": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetLoginProfile": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetSshPublicKey": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "ImportSshPublicKey": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateSshPublicKey": {
+          "timeout_millis": 10000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}