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

data/proto_docs/google/cloud/ftp/v1/service.rb

@@ -0,0 +1,683 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 Ftp
+      module V1
+        # Configuration for external server.
+        # @!attribute [r] ip_address
+        #   @return [::String]
+        #     Output only. IP address of the LB via which clients will connect.
+        # @!attribute [rw] allowed_cidr_blocks
+        #   @return [::Array<::String>]
+        #     Optional. List of CIDR blocks that are allowed to access the Server.
+        #     A CIDR range consists of an IP Address and a prefix length to construct the
+        #     subnet mask. By default, the prefix length is 32 (i.e. matches a single IP
+        #     address). For now, only IPV4 addresses are supported.
+        #     Examples: "203.0.113.0/24" -
+        #     matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255.
+        #     "0.0.0.0/0" - matches against any IP address.
+        #     This field must contain at least one entry if the access type is EXTERNAL.
+        #     The number of allowed CIDR blocks cannot exceed 500.
+        #     Example: 192.168.0.0/16
+        class ExternalServerConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for private server accessible via PSC.
+        # @!attribute [r] service_attachment
+        #   @return [::String]
+        #     Output only. The resource name of the service attachment.
+        #     Format:
+        #     `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`
+        # @!attribute [rw] consumer_accept_list
+        #   @return [::Array<::Google::Cloud::Ftp::V1::InternalServerConfig::AllowedConsumer>]
+        #     Required. A list of projects that are permitted to connect.
+        #     At least one project is required in the allow list.
+        # @!attribute [rw] consumer_reject_list
+        #   @return [::Array<::Google::Cloud::Ftp::V1::InternalServerConfig::DeniedConsumer>]
+        #     Optional. A list of projects that are denied connection.
+        #     Format: "projects/sample_project_id" or "projects/1234567890"
+        #     Projects in this list will be denied access, even if they are included in
+        #     the `allow_list`. If this list is empty, no projects are explicitly
+        #     rejected.
+        # @!attribute [r] psc_endpoints
+        #   @return [::Array<::Google::Cloud::Ftp::V1::InternalServerConfig::PscEndpoint>]
+        #     Output only. Details of endpoints created by the customer.
+        class InternalServerConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A consumer project or network that is permitted to connect to the server
+          # via PSC.
+          # @!attribute [rw] project
+          #   @return [::String]
+          #     The project ID or number of the consumer project.
+          #     Must be in the format: `projects/{project}`.
+          # @!attribute [rw] connection_limit
+          #   @return [::Integer]
+          #     Required. The connection limit for the consumer.
+          #     Value must be greater than 0.
+          class AllowedConsumer
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A consumer project or network that is denied to connect to the server via
+          # PSC.
+          # @!attribute [rw] project
+          #   @return [::String]
+          #     The project ID or number of the consumer project.
+          #     Must be in the format: `projects/{project}`.
+          class DeniedConsumer
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Details of PSC endpoint created by customer.
+          # @!attribute [r] endpoint
+          #   @return [::String]
+          #     Output only. This is a Resource name for Private Service Connect
+          #     endpoint. Format:
+          #     `projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}`
+          # @!attribute [r] network
+          #   @return [::String]
+          #     Output only. The consumer network.
+          #     Format: `projects/{project}/locations/{location}/networks/{network}`
+          # @!attribute [r] status
+          #   @return [::String]
+          #     Output only. The status of the connected endpoint.
+          class PscEndpoint
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Represents credentials of an FTP Server.
+        # @!attribute [r] fingerprint
+        #   @return [::String]
+        #     Output only. The fingerprint is a hash of the public key, and is displayed
+        #     when clients access the server for the first time to verify the server's
+        #     identity.
+        # @!attribute [r] asymmetric_algorithm
+        #   @return [::String]
+        #     Output only. Asymmetric algorithm used by the public key.
+        #     Possible values (can be expanded in future):
+        #     - ssh-ed25519
+        class ServerCredential
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message describing Server object
+        # @!attribute [rw] external_config
+        #   @return [::Google::Cloud::Ftp::V1::ExternalServerConfig]
+        #     Configuration for external access.
+        #
+        #     Note: The following fields are mutually exclusive: `external_config`, `internal_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] internal_config
+        #   @return [::Google::Cloud::Ftp::V1::InternalServerConfig]
+        #     Configuration for internal access.
+        #
+        #     Note: The following fields are mutually exclusive: `internal_config`, `external_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. name of resource
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Update time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels as key value pairs
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Optional. Display name of the Server
+        # @!attribute [rw] access_type
+        #   @return [::Google::Cloud::Ftp::V1::Server::AccessType]
+        #     Required. The access type of the Server.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Ftp::V1::Server::State]
+        #     Output only. The state of the server.
+        # @!attribute [r] google_managed_server_credential
+        #   @return [::Google::Cloud::Ftp::V1::ServerCredential]
+        #     Output only. Credentials of the FTP Server.
+        # @!attribute [r] service_agent
+        #   @return [::String]
+        #     Output only. Service agent used to access the customer bucket.
+        class Server
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The access type of the Server.
+          module AccessType
+            # Default value. This value is unused.
+            ACCESS_TYPE_UNSPECIFIED = 0
+
+            # Server is assigned a public IP.
+            EXTERNAL = 1
+
+            # Server is assigned an internal IP.
+            INTERNAL = 2
+          end
+
+          # Tracks Server status.
+          module State
+            # Default value. This value is unused.
+            STATE_UNSPECIFIED = 0
+
+            # Server is being created.
+            CREATING = 1
+
+            # Server is starting.
+            STARTING = 2
+
+            # Server is ready to be used.
+            ACTIVE = 3
+
+            # Server is stopping.
+            STOPPING = 4
+
+            # Server is stopped.
+            STOPPED = 5
+
+            # Server is being deleted.
+            DELETING = 6
+
+            # Server is in error state.
+            ERROR = 7
+
+            # Server is being updated.
+            UPDATING = 8
+          end
+        end
+
+        # Message for requesting list of Servers
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent value for ListServersRequest
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. Server may return fewer items than
+        #     requested. If unspecified, server will pick an appropriate default.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results the server should return.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filtering results
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Hint for how to order the results
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Ftp::V1::ServerView]
+        #     Optional. The view of the Server resource to return.
+        class ListServersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for response to listing Servers
+        # @!attribute [rw] servers
+        #   @return [::Array<::Google::Cloud::Ftp::V1::Server>]
+        #     The list of Server
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token identifying a page of results the server should return.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unordered list. Locations that could not be reached.
+        class ListServersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for getting a Server
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Ftp::V1::ServerView]
+        #     Optional. The view of the Server resource to return.
+        class GetServerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for creating a Server
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Value for parent.
+        # @!attribute [rw] server_id
+        #   @return [::String]
+        #     Required. A unique ID for the server. Must start with a lowercase letter,
+        #     and end with a lowercase letter or number. Can contain lowercase letters,
+        #     numbers, and hyphens. Maximum length is 30 characters.
+        # @!attribute [rw] server
+        #   @return [::Google::Cloud::Ftp::V1::Server]
+        #     Required. The resource being created
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed. The server will
+        #     guarantee that for at least 60 minutes since the first request.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request
+        #     ID, the server can check if original operation with the same request ID
+        #     was received, and if so, will ignore the second request. This prevents
+        #     clients from accidentally creating duplicate commitments.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class CreateServerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for updating a Server
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Field mask is used to specify the fields to be overwritten in the
+        #     Server resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask. If the
+        #     user does not provide a mask then all fields present in the request will be
+        #     overwritten.
+        # @!attribute [rw] server
+        #   @return [::Google::Cloud::Ftp::V1::Server]
+        #     Required. The resource being updated
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed. The server will
+        #     guarantee that for at least 60 minutes since the first request.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request
+        #     ID, the server can check if original operation with the same request ID
+        #     was received, and if so, will ignore the second request. This prevents
+        #     clients from accidentally creating duplicate commitments.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class UpdateServerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for deleting a Server
+        # Note: Cascading delete is not supported. Any nested User resources
+        # under this Server must be deleted before the Server itself can be deleted.
+        # Attempting to delete a Server with active User resources will result in an
+        # error.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource
+        class DeleteServerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Mapping of backing Cloud Storage path to the directory where the user lands
+        # in the SFTP server. If directory is not specified, it'll default to '/'.
+        #
+        # Eg 1 -
+        # (bucket_name: bucket, bucket_prefix: path1/path2, directory:
+        # /abc/def/username)
+        #
+        # The user will land at /abcd/def/username, and the view there will match that
+        # of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix
+        # '/bucket/path1' and there will be no such directory in the view.
+        #
+        # Eg 2 -
+        # (bucket_name: bucket, bucket_prefix: path1/path2, directory: '')
+        #
+        # The user will land at '/', and the view there will match
+        # that of /bucket/path1/path2. The user will not be aware of Cloud Storage
+        # prefix '/bucket/path1/path2' and there will be no such directory in the view.
+        # @!attribute [rw] bucket
+        #   @return [::String]
+        #     Required. Name of the bucket.
+        # @!attribute [rw] bucket_prefix
+        #   @return [::String]
+        #     Optional. Prefix inside the bucket.
+        # @!attribute [rw] directory
+        #   @return [::String]
+        #     Required. Directory where the user lands in the SFTP server.
+        # @!attribute [rw] permission
+        #   @return [::Google::Cloud::Ftp::V1::StorageDirectoryMapping::Permission]
+        #     Required. Permission to the bucket.
+        class StorageDirectoryMapping
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Tracks read/write access to the bucket.
+          module Permission
+            # Permission unspecified.
+            PERMISSION_UNSPECIFIED = 0
+
+            # Read only permission.
+            READ_ONLY = 1
+
+            # Read write permission.
+            READ_WRITE = 2
+          end
+        end
+
+        # Message describing User object
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. User-friendly name via which User will be identified.
+        #     projects/\\{project}/locations/\\{location}/servers/\\{server}/users/\\{user}
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. [Output only] Update time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. Labels as key value pairs
+        # @!attribute [r] username
+        #   @return [::String]
+        #     Output only. [Output only] The username of the user.
+        # @!attribute [rw] customer_service_account
+        #   @return [::String]
+        #     Required. Service account in customer project attached to this SFTP User.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Ftp::V1::User::State]
+        #     Output only. Tracks user creation.
+        # @!attribute [rw] user_credentials
+        #   @return [::Array<::Google::Cloud::Ftp::V1::UserCredential>]
+        #     Required. User credential for the user.
+        #     The maximum number of user credentials is 10.
+        # @!attribute [rw] storage_directory_mappings
+        #   @return [::Array<::Google::Cloud::Ftp::V1::StorageDirectoryMapping>]
+        #     Required. Mapping of Cloud Storage buckets to directories where the user
+        #     will land in the SFTP server.
+        class User
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Tracks user creation.
+          module State
+            # State unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # User is being created.
+            CREATING = 1
+
+            # User is ready to be used.
+            ACTIVE = 2
+
+            # User creation failed.
+            ERROR = 3
+
+            # The resource is being updated.
+            UPDATING = 4
+
+            # The resource is being deleted.
+            DELETING = 5
+          end
+        end
+
+        # Message for requesting list of Users
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Parent value for ListUsersRequest
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Requested page size. User may return fewer items than requested.
+        #     The maximum value is 1000; The default value is 50 if the field is omitted
+        #     (or set to 0).
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A token identifying a page of results the user should return.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filtering results
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Hint for how to order the results
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Ftp::V1::UserView]
+        #     Optional. The view of the User resource to return.
+        class ListUsersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for response to listing Users
+        # @!attribute [rw] users
+        #   @return [::Array<::Google::Cloud::Ftp::V1::User>]
+        #     The list of User
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token identifying a page of results the user should return.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Unordered list. Locations that could not be reached.
+        class ListUsersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for getting a User
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Ftp::V1::UserView]
+        #     Optional. The view of the User resource to return.
+        class GetUserRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for creating a User
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Value for parent.
+        # @!attribute [rw] user_id
+        #   @return [::String]
+        #     Required. A unique user ID for the SFTP user. The user ID must start with a
+        #     lowercase letter and can include lowercase letters, numbers, or hyphens.
+        # @!attribute [rw] user
+        #   @return [::Google::Cloud::Ftp::V1::User]
+        #     Required. The resource being created
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed. The server will
+        #     guarantee that for at least 60 minutes since the first request.
+        #
+        #     For example, consider a situation where you make an initial request and the
+        #     request times out. If you make the request again with the same request
+        #     ID, the server can check if original operation with the same request ID
+        #     was received, and if so, will ignore the second request. This prevents
+        #     clients from accidentally creating duplicate commitments.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class CreateUserRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for updating a User
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Field mask is used to specify the fields to be overwritten in the
+        #     User resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask. If the
+        #     user does not provide a mask then all fields present in the request will be
+        #     overwritten.
+        # @!attribute [rw] user
+        #   @return [::Google::Cloud::Ftp::V1::User]
+        #     Required. The resource being updated
+        class UpdateUserRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for deleting a User
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     Optional. If set to true, the request will force the deletion of the User.
+        class DeleteUserRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for starting a Server.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource
+        #     Format: `projects/{project}/locations/{location}/servers/{server}`
+        class StartServerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for stopping a Server.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        #     Format: `projects/{project}/locations/{location}/servers/{server}`
+        class StopServerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message describing UserCredential object
+        # @!attribute [rw] credential_name
+        #   @return [::String]
+        #     Required. Name of the user credential.
+        # @!attribute [rw] credential_type
+        #   @return [::Google::Cloud::Ftp::V1::UserCredential::Type]
+        #     Required. Type of credential.
+        # @!attribute [rw] ssh_public_key_body
+        #   @return [::String]
+        #     Optional. SSH public key body in OpenSSH format.
+        #     Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
+        class UserCredential
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Type of credential.
+          module Type
+            # Type unspecified.
+            TYPE_UNSPECIFIED = 0
+
+            # Public key credential.
+            PUBLIC_KEY = 1
+          end
+        end
+
+        # Represents the metadata of the long-running operation.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation was created.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation finished running.
+        # @!attribute [r] target
+        #   @return [::String]
+        #     Output only. Server-defined resource path for the target of the operation.
+        # @!attribute [r] verb
+        #   @return [::String]
+        #     Output only. Name of the verb executed by the operation.
+        # @!attribute [r] status_message
+        #   @return [::String]
+        #     Output only. Human-readable status of the operation, if any.
+        # @!attribute [r] requested_cancellation
+        #   @return [::Boolean]
+        #     Output only. Identifies whether the user has requested cancellation
+        #     of the operation. Operations that have been cancelled successfully
+        #     have
+        #     {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
+        #     value with a {::Google::Rpc::Status#code google.rpc.Status.code} of `1`,
+        #     corresponding to `Code.CANCELLED`.
+        # @!attribute [r] api_version
+        #   @return [::String]
+        #     Output only. API version used to start the operation.
+        class OperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # View for Server resource.
+        module ServerView
+          # Default value. Equivalent to SERVER_VIEW_BASIC.
+          SERVER_VIEW_UNSPECIFIED = 0
+
+          # Basic view. Excludes heavy configurations (internal_config,
+          # external_config, google_managed_server_credential).
+          SERVER_VIEW_BASIC = 1
+
+          # Full view. Includes all fields.
+          SERVER_VIEW_FULL = 2
+        end
+
+        # View for User resource.
+        module UserView
+          # Default value. Equivalent to USER_VIEW_BASIC.
+          USER_VIEW_UNSPECIFIED = 0
+
+          # Basic view. Excludes heavy configurations (user_credentials,
+          # storage_directory_mappings).
+          USER_VIEW_BASIC = 1
+
+          # Full view. Includes all fields.
+          USER_VIEW_FULL = 2
+        end
+      end
+    end
+  end
+end