google-cloud-os_login-v1beta 0.1.0

data/proto_docs/google/cloud/oslogin/common/common.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module OsLogin
+      module Common
+        # The POSIX account information associated with a Google account.
+        # @!attribute [rw] primary
+        #   @return [::Boolean]
+        #     Only one POSIX account can be marked as primary.
+        # @!attribute [rw] username
+        #   @return [::String]
+        #     The username of the POSIX account.
+        # @!attribute [rw] uid
+        #   @return [::Integer]
+        #     The user ID.
+        # @!attribute [rw] gid
+        #   @return [::Integer]
+        #     The default group ID.
+        # @!attribute [rw] home_directory
+        #   @return [::String]
+        #     The path to the home directory for this account.
+        # @!attribute [rw] shell
+        #   @return [::String]
+        #     The path to the logic shell for this account.
+        # @!attribute [rw] gecos
+        #   @return [::String]
+        #     The GECOS (user information) entry for this account.
+        # @!attribute [rw] system_id
+        #   @return [::String]
+        #     System identifier for which account the username or uid applies to.
+        #     By default, the empty value is used.
+        # @!attribute [r] account_id
+        #   @return [::String]
+        #     Output only. A POSIX account identifier.
+        # @!attribute [rw] operating_system_type
+        #   @return [::Google::Cloud::OsLogin::Common::OperatingSystemType]
+        #     The operating system type where this account applies.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The canonical resource name.
+        class PosixAccount
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The SSH public key information associated with a Google account.
+        # @!attribute [rw] key
+        #   @return [::String]
+        #     Public key text in SSH format, defined by
+        #     <a href="https://www.ietf.org/rfc/rfc4253.txt" target="_blank">RFC4253</a>
+        #     section 6.6.
+        # @!attribute [rw] expiration_time_usec
+        #   @return [::Integer]
+        #     An expiration time in microseconds since epoch.
+        # @!attribute [r] fingerprint
+        #   @return [::String]
+        #     Output only. The SHA-256 fingerprint of the SSH public key.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The canonical resource name.
+        class SshPublicKey
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The operating system options for account entries.
+        module OperatingSystemType
+          # The operating system type associated with the user account information is
+          # unspecified.
+          OPERATING_SYSTEM_TYPE_UNSPECIFIED = 0
+
+          # Linux user account information.
+          LINUX = 1
+
+          # Windows user account information.
+          WINDOWS = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/oslogin/v1beta/oslogin.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module OsLogin
+      module V1beta
+        # The user profile information used for logging in to a virtual machine on
+        # Google Compute Engine.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. A unique user ID.
+        # @!attribute [rw] posix_accounts
+        #   @return [::Array<::Google::Cloud::OsLogin::Common::PosixAccount>]
+        #     The list of POSIX accounts associated with the user.
+        # @!attribute [rw] ssh_public_keys
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::OsLogin::Common::SshPublicKey}]
+        #     A map from SSH public key fingerprint to the associated key object.
+        class LoginProfile
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::OsLogin::Common::SshPublicKey]
+          class SshPublicKeysEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A request message for deleting a POSIX account entry.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. 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}`.
+        class DeletePosixAccountRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for deleting an SSH public key.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. 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}`.
+        class DeleteSshPublicKeyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for retrieving the login profile information for a user.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The unique ID for the user in format `users/{user}`.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID of the Google Cloud Platform project.
+        # @!attribute [rw] system_id
+        #   @return [::String]
+        #     A system ID for filtering the results of the request.
+        class GetLoginProfileRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for retrieving an SSH public key.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. 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}`.
+        class GetSshPublicKeyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for importing an SSH public key.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     The unique ID for the user in format `users/{user}`.
+        # @!attribute [rw] ssh_public_key
+        #   @return [::Google::Cloud::OsLogin::Common::SshPublicKey]
+        #     Required. The SSH public key and expiration time.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     The project ID of the Google Cloud Platform project.
+        class ImportSshPublicKeyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A response message for importing an SSH public key.
+        # @!attribute [rw] login_profile
+        #   @return [::Google::Cloud::OsLogin::V1beta::LoginProfile]
+        #     The login profile information for the user.
+        class ImportSshPublicKeyResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A request message for updating an SSH public key.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. 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}`.
+        # @!attribute [rw] ssh_public_key
+        #   @return [::Google::Cloud::OsLogin::Common::SshPublicKey]
+        #     Required. The SSH public key and expiration time.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Mask to control which fields get updated. Updates all if not present.
+        class UpdateSshPublicKeyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/empty.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for `Empty` is empty JSON object `{}`.
+    class Empty
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end